v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB

Create an Application

Create a lead.

post/Leads

Headers

api-versionstring

Request body

thirdPartyCustomerIdstring required

Gets or sets the third party's unique id for a merchant.

companyNamestring required

Gets or sets the merchant's company name.

countryISOCode'GBR' | 'IRL' | 'NLD' | 'BEL' | 'POL' | 'USA' | 'DEU' | 'FRA' | 'ESP' | 'DNK' required

Gets or sets the ISO country code for the merchant.

loanCurrencyISOCodestring required

Gets or sets the ISO currency code for the merchant.

keyContactNamestring required

Gets or sets the key merchant contact who will be applying for the loan.

companyType'Ltd' | 'Plc' | 'Llp' | 'SoleTrader' | 'Partnership' | 'Llc' | 'BusinessCorporation' | 'Dac' | 'Eenmanszaak' | 'Bv' | 'Cv' | 'Nv' | 'Vof' | 'NaamlozeVennootschap' | 'SpZoo' | 'SpkSpj' | 'Scspp' | 'SaSKA' | 'Jdg' | 'GmbhUg' | 'EK' | 'Gewerbebetrieb' | 'GbrOhg' | 'Gbr' | 'EGbr' | 'Ohg' | 'Kg' | 'Aktiengesellschaft' | 'SlSlne' | 'SociedadColectiva' | 'SociedadComanditaria' | 'EIAutonomo' | 'SociedadCivil' | 'SociedadCooperativa' | 'SARL' | 'EINomPropre' | 'SNC' | 'SocieteCooperative' | 'SA' | 'SAS' | 'EURL' | 'SCP' | 'SCS' | 'SASU' | 'AS' | 'ApS' | 'KS' | 'PS' | 'Fmba' | 'Andelsselskab' | 'Amba' | 'ErhvervsdrivendeFond' | 'IS' | 'Smba' | 'SI' | 'SelvstændigOffentligVirksomhed' | 'Partrederi' | 'Filial' | 'Enkeltmandsvirksomhed' | 'PMV' | 'Forening' required

Gets or sets the key merchant company type.

contactPhoneNumberstring required

Gets or sets the merchant's contact phone number.

contactEmailAddressstring email required

Gets or sets the merchant's key contact email address.

confirmedCreditSearchboolean

Gets or sets a value indicating whether the lead has given their consent for a credit search. This parameter has to be true in order for the lead to be able to submit the application (stage 1).

thirdPartyLeadIdstring nullable

Gets or sets the third party's id for the specific application (lead).

monthlyCardRevenuenumber double

Gets or sets the monthly card revenue for the merchant.

numberOfPaymentsPerMonthinteger

Gets or sets the number of payments a merchant has each month.

sweepPercentagenumber double

Gets or sets the percentage of daily sales the merchant wants to use to pay back the loan.

monthsTradinginteger

Gets or sets the number of months the merchant has been trading.

loanAmountnumber double

Gets or sets the size of loan the merchant wants.

companyWebsitestring nullable

Gets or sets the merchants company website URL.

companyNumberstring nullable

Gets or sets the registered company number for the merchant.

vatNumberstring nullable

Gets or sets the VAT number for the merchant.

midstring nullable

Gets or sets the MID for the merchant.

merchantIdsstring[] nullable

Gets or sets the MerchantIds for the merchant if there is more than one.

additionalInfoobject nullable

Gets or sets a list of key values pairs representing any additional lead data not already covered.

signupClientIpstring nullable

Gets or sets the Ip address of the merchant.

notificationURLstring nullable

(DEPRECATED - please see https://docs.youlend.com/reference/webhooks-intro for how to subscribe to notifications).

employerIdentificationNumberstring nullable

Gets or sets the merchant's tax identification number (required for USA).

tradingNamestring nullable

Gets or sets the merchant's trading name.

preApprovalIdstring uuid

Gets or sets the PreApprovalId.

ownerUserIdstring uuid

Gets or sets the OwnerUserId.

preferredLanguageCode'EN' | 'NL' | 'NL_BE' | 'ES' | 'DE' | 'PL' | 'EN_US' | 'FR' | 'DA' nullable

Gets or sets the PreferredLanguageCode.

preferredRepaymentMethod'SBR' | 'DD' | 'SalesBasedRepaymentManagingProcessor' nullable

Gets or sets the preferred repayment method for the merchant. Accepted values: "Sales-Based Repayment", "Direct Debit Fixed".

Response

Returns a CreateThirdPartyAdvanceOnboardingResultModel.

leadIdstring uuid

Gets or sets the Lead Id.

leadURLstring nullable

Gets or sets the Lead redirect URL.

signUpURLstring nullable

Gets or sets the broker redirect URL.

openBankingURLstring nullable

Gets or sets the Open Banking Url.