Create a lead.

post

https://partners.staging-youlendapi.com/onboarding/Leads

Notice that the 200 response includes the signUpURL to redirect a merchant to their application in the YouLend hosted journey.

Partners can use the variable thirdPartyCustomerId to share their own internal customer ID for the merchant, making it easier for partners to match the lead to their internal systems.

📘
Good to know
For Embedded components please Include "leadType": "Embedded" in every Create Lead request. This classifies newly created leads as Embedded. API partners do not need to change their requests: when leadType is omitted or empty, it defaults to Api.

🚧
weBe aware (USA)

In the USA,employerIdentificationNumber param is mandatory unless companyType is SoleTrader.

When submitting an Address, the region param is mandatory and must correspond to a valid State (eg. "New York"), or a valid ANSI 2 letter State code (eg. "NY").

signupClientIp is required for USA leads.

📘
Good to know
The companyWebsite parameter is optional but strongly recommended. Including it in the Create Lead request helps YouLend verify the business and significantly reduces the likelihood of pushbacks. Please provide this value whenever possible.

Body Params

A YL.Web.Api.ThirdParty.Onboarding.Models.ThirdPartyOnboardingModel containing the data required to create the lead.

Third party onboarding model for create a Youlend lead.

thirdPartyCustomerId

string

required

length ≥ 1

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

companyName

string

required

length between 2 and 200

Gets or sets the merchant's company name.

countryISOCode

string

enum

required

length ≥ 1

Gets or sets the ISO country code for the merchant.

loanCurrencyISOCode

string

required

length ≥ 1

Gets or sets the ISO currency code for the merchant.

keyContactName

string

required

length between 1 and 255

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

companyType

string

enum

required

length ≥ 1

Gets or sets the key merchant company type.

registeredAddress

object

required

Address Data Model.

contactPhoneNumber

string

required

length between 8 and 20

Gets or sets the merchant's contact phone number.

contactEmailAddress

string

required

length between 1 and 255

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

confirmedCreditSearch

boolean

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).

thirdPartyLeadId

string | null

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

monthlyCardRevenue

double

Gets or sets the monthly card revenue for the merchant.

numberOfPaymentsPerMonth

int32

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

sweepPercentage

double

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

monthsTrading

int32

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

loanAmount

double

Gets or sets the size of loan the merchant wants.

companyWebsite

string | null

Gets or sets the merchants company website URL.

companyNumber

string | null

Gets or sets the registered company number for the merchant.

vatNumber

string | null

Gets or sets the VAT number for the merchant.

mid

string | null

Gets or sets the MID for the merchant.

merchantIds

array of strings | null

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

merchantIds

additionalInfo

object | null

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

signupClientIp

string | null

Gets or sets the Ip address of the merchant.

notificationURL

string | null

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

employerIdentificationNumber

string | null

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

renewal

object

Renewal data model.

tradingAddress

object

Address Data Model.

tradingName

string | null

Gets or sets the merchant's trading name.

preApprovalId

uuid

Gets or sets the PreApprovalId.

leadType

string | null

enum

Gets or sets the lead type. Defaults to Api when omitted.

Allowed:

ownerUserId

uuid

Gets or sets the OwnerUserId.

preferredLanguageCode

string | null

enum

Gets or sets the PreferredLanguageCode.

preferredRepaymentMethod

string | null

enum

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

Allowed:

secondaryLendingPartnerDetails

object

Secondary lending partner details model.

industries

array of objects | null

Gets or sets the Industries.

industries

Headers

api-version

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Good to know

weBe aware (USA)

Good to know

200Returns a CreateThirdPartyAdvanceOnboardingResultModel.

400Bad Request

404Not Found