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 Germany
| 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 | GmbhUg EK Gewerbebetrieb GbrOhg Gbr eGbR OHG KG |
companyNumber | Handelsregisternummer, usually has the format HRA12345 |
mobilePhoneNumber | The format for this parameter is: +49xxxxxxxxxxx |
countryISOCode | DEU |
loanCurrencyISOCode | EUR |
companyType mappings for Germany
companyType mappings for Germany| Name | Long Name | YouLend Mapping | Company Number Expected |
|---|---|---|---|
| Gmbh | Gesellschaft mit beschränkter Haftung | GmbhUg | Yes |
| AG | Aktiengesellschaft | GmbhUg | Yes |
| UG | Unternehmergesellschaft (haftungsbeschränkt) | GmbhUg | Yes |
| OHG | offene Handelsgesellschaft | OHG | Yes |
| KG | Kommanditgesellschaft | KG | Yes |
| GbR | Gesellschaft bürgerlichen Rechts | Gbr | No |
| KGaA | Kommanditgesellschaft auf Aktien | KG | Yes |
| eG | eingetragene Genossenschaft | eGbR | Yes |
| (Solo)Selbständige / (Klein)Gewerbetreibende, Freelancer | Einzelunternehmer mit Gewerbeanmeldung | Gewerbebetrieb | No |
| Ltd | Limited | GmbhUg | Yes |
| PartG | Partnerschaftsgesellschaft | GbrOhg | Yes/No |
| Freiberufler (ohne Gewerbeanmeldung) | Katalogberufe und katalogähnliche Berufe (Ärzte, Rechtsanwälte, Ingenieure, etc) | Gewerbebetrieb | No |
| SE | Europäische Aktiengesellschaft (SE) | GmbhUg | Yes |
| e. V. | eingetragener Verein | eGbR | Yes |
| GmbH & Co. KG | Gesellschaft mit beschränkter Haftung & Compagnie Kommanditgesellschaft | GmbhUg | Yes |
| e. K. | eingetragener Kaufmann | EK | Yes |
| UG & Co. KG | Die Unternehmergesellschaft (haftungsbeschränkt) & Co. KG | GmbhUg | Yes |
| gGmbH | gemeinnützige Gesellschaft mit beschränkter Haftung | GmbhUg | Yes |
| gUG | gemeinnützige Unternehmergesellschaft (haftungsbeschränkt) | Charity (Youlend can't fund) | N/a |
| K.d.ö.R. | Körperschaft des öffentlichen Rechts | Charity (Youlend can't fund) | N/a |
Example Create Lead Request
{
"thirdPartyCustomerId": "16d81dac",
"confirmedCreditSearch": true,
"countryISOCode": "DEU",
"loanCurrencyISOCode": "EUR",
"keyContactName": "Sophie Allard",
"companyType": "GmbhUg",
"companyName": "Test Company",
"companyNumber": "HRA12345",
"registeredAddress": {
"line1": "5 Happy Road",
"city": "Berlin",
"areaCode": "99998",
"country": "Germany"
},
"contactPhoneNumber": "+4900000000000",
"contactEmailAddress": "[email protected]",
"preferredLanguageCode": "de",
"confirmedCreditSearch": true
}