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.

Environment	Base 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 Poland

Environment	URL
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

Parameters	Description
`companyType`	Poland's Company Types
`companyNumber`	10-digit NIP number (submit stage 1 will return an error if this param is not provided)
`mobilePhoneNumber`	The format for this parameter is: `+48xxxxxxxxx`
`countryISOCode`	`POL`
`loanCurrencyISOCode`	`PLN`
`placeOfBirth`	This param within the Update significant persons endpoint is mandatory for Poland. The format for this param is: {city}, {country}` where country follows the ISO 3166 3 letter code in Country ISO Codes. Example: Warsaw, POL

Example Create a lead request

{
  "thirdPartyCustomerId": "89ab144",
  "confirmedCreditSearch": true,
  "countryISOCode": "POL",
  "loanCurrencyISOCode": "PLN",
  "keyContactName": "Mike Bloggs",
  "companyType": "SpkSpj",
  "companyName": "Test Company Limited",
  "companyNumber": "9152588921",
  "registeredAddress": {
    "line1": "Starokrzepice 91",
    "city": "Starokrzepice",
    "region": "Gmina Krzepice",
    "areaCode": "42161",
    "country": "Poland"
  },
  "contactPhoneNumber": "+48000000000",
  "contactEmailAddress": "[email protected]",
   "additionalInfo": {
                        "youLendSales": "true",
                        "language": "pl",
                        "Lead source": "email"
                     }
}

Example Update significant persons request

{
  "significantPersons": [
    {
      "firstName": "Michał",
      "surname": "Bloggs",
      "typeOfPerson": "Director",
      "address": {
        "line1": "Starokrzepice 91",
        "line2": null,
        "line3": null,
        "city": "Starokrzepice",
        "region": "Gmina Krzepice",
        "areaCode": "42161",
        "country": "POL"
      },
      "dateOfBirth": {
        "year": 1985,
        "month": 6,
        "day": 15
      },
      "emailAddress": "[email protected]",
      "mobilePhoneNumber": "48000000000",
      "percentageOwned": 100,
      "nationality": "POL",
      "placeOfBirth": "Warsaw, POL"
    }
  ]
}