United Kingdom guide

Authentication and environments

Base URLs for the EU platform (when interacting with YouLends APIs)

When interacting with our EU specific endpoints, please use the below URLs.

EnvironmentBase URL
EU (production)https://youlendapi.com
EU (staging)https://partners.staging-youlendapi.com

Authentication URLs (to request an access token)

📘

Good to know

Please visit our Authentication guide for more information regarding authenticating in United Kingdom

EnvironmentURL
EU (production)https://youlend.eu.auth0.com/oauth/token
EU (staging)https://youlend-stag.eu.auth0.com/oauth/token

Onboarding APIs

This section focuses on all APIs that partners can interact with when onboarding a merchant.

Parameter callouts

ParametersDescription
companyTypeLtd Plc Llp SoleTrader Partnership
companyNumber8-figure CRN (submit stage 1 will return an error if this CRN is not provided, unless the business is a SoleTrader or Partnership)
mobilePhoneNumberThe format for this parameter is: +44xxxxxxxxxx
countryISOCodeGBR
loanCurrencyISOCodeGBP

Example request

{
  "thirdPartyCustomerId": "16d81dac",
  "confirmedCreditSearch": true,
  "countryISOCode": "GBR",
  "loanCurrencyISOCode": "GBP",
  "keyContactName": "Sophie Allard",
  "companyType": "Ltd",
  "companyName": "Test Company Limited",
  "companyNumber": "97537567",
  "registeredAddress": {
    "line1": "5 Happy Road",
    "city": "London",
    "areaCode": "W49JK",
    "country": "UK"
  },
  "contactPhoneNumber": "+447000000000",
  "contactEmailAddress": "[email protected]",
  "preferredLanguageCode": "en",
  "confirmedCreditSearch": true
}