---
title: "Create a lead."
method: POST
path: "/Leads"
tags: ["Create an Application"]
---

# Create a lead.

`POST /Leads`

## Headers

- `api-version` string

## Request body

- ThirdPartyOnboardingModel — Third party onboarding model for create a Youlend lead.
  - `thirdPartyCustomerId` string, required — Gets or sets the third party's unique id for a merchant.
  - `companyName` string, 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.
  - `loanCurrencyISOCode` string, required — Gets or sets the ISO currency code for the merchant.
  - `keyContactName` string, 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.
  - `registeredAddress` AddressModel, required — Address Data Model.
    - `line1` string, required — Gets or sets Address Line 1.
    - `line2` string, nullable — Gets or sets Address Line 2.
    - `line3` string, nullable — Gets or sets Address Line 3.
    - `city` string, required — Gets or sets the City.
    - `region` string, nullable — Gets or sets the Region.
    - `areaCode` string, required — Gets or sets the Area Code.
    - `country` string, nullable — Gets or sets the Country. Cannot be null or empty if YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.CountryISOCode is not set. If both are set, we use YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.Country.
    - `countryISOCode` 'GBR' | 'IRL' | 'NLD' | 'BEL' | 'POL' | 'USA' | 'DEU' | 'FRA' | 'ESP' | 'DNK' — Gets or sets the CountryISOCode. Cannot be null or empty if YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.Country is not set. If both are set, we use YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.Country.
  - `contactPhoneNumber` string, required — Gets or sets the merchant's contact phone number.
  - `contactEmailAddress` string, email, required — 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, nullable — Gets or sets the third party's id for the specific application (lead).
  - `monthlyCardRevenue` number, double — Gets or sets the monthly card revenue for the merchant.
  - `numberOfPaymentsPerMonth` integer — Gets or sets the number of payments a merchant has each month.
  - `sweepPercentage` number, double — Gets or sets the percentage of daily sales the merchant wants to use to pay back the loan.
  - `monthsTrading` integer — Gets or sets the number of months the merchant has been trading.
  - `loanAmount` number, double — Gets or sets the size of loan the merchant wants.
  - `companyWebsite` string, nullable — Gets or sets the merchants company website URL.
  - `companyNumber` string, nullable — Gets or sets the registered company number for the merchant.
  - `vatNumber` string, nullable — Gets or sets the VAT number for the merchant.
  - `mid` string, nullable — Gets or sets the MID for the merchant.
  - `merchantIds` string[], nullable — Gets or sets the MerchantIds for the merchant if there is more than one.
  - `additionalInfo` object, nullable — Gets or sets a list of key values pairs representing any additional lead data not already covered.
  - `signupClientIp` string, nullable — Gets or sets the Ip address of the merchant.
  - `notificationURL` string, nullable — (DEPRECATED - please see https://docs.youlend.com/reference/webhooks-intro for how to subscribe to notifications).
  - `employerIdentificationNumber` string, nullable — Gets or sets the merchant's tax identification number (required for USA).
  - `renewal` RenewalModel — Renewal data model.
    - `isRenewalLead` boolean — Gets or sets a value indicating whether a lead is renewal.
    - `previousLeadId` string, uuid — Gets or sets the previous lead id.
  - `tradingAddress` AddressModel — Address Data Model.
    - `line1` string, required — Gets or sets Address Line 1.
    - `line2` string, nullable — Gets or sets Address Line 2.
    - `line3` string, nullable — Gets or sets Address Line 3.
    - `city` string, required — Gets or sets the City.
    - `region` string, nullable — Gets or sets the Region.
    - `areaCode` string, required — Gets or sets the Area Code.
    - `country` string, nullable — Gets or sets the Country. Cannot be null or empty if YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.CountryISOCode is not set. If both are set, we use YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.Country.
    - `countryISOCode` 'GBR' | 'IRL' | 'NLD' | 'BEL' | 'POL' | 'USA' | 'DEU' | 'FRA' | 'ESP' | 'DNK' — Gets or sets the CountryISOCode. Cannot be null or empty if YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.Country is not set. If both are set, we use YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.Country.
  - `tradingName` string, nullable — Gets or sets the merchant's trading name.
  - `preApprovalId` string, uuid — Gets or sets the PreApprovalId.
  - `ownerUserId` string, 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".
  - `secondaryLendingPartnerDetails` SecondaryLendingPartnerDetailsModel — Secondary lending partner details model.
    - `secondaryLendingPartnerId` string, nullable — Gets or sets the secondary lending partner id.
    - `secondaryLendingPartnerName` string, nullable — Gets or sets the secondary lending partner name.
  - `industries` Industry[], nullable — Gets or sets the Industries.
    - `code` string, required — Gets or sets the SIC code for the industry.
    - `description` string, required — Gets or sets the description of the industry.

## Response `200`

Returns a CreateThirdPartyAdvanceOnboardingResultModel.

- CreateThirdPartyAdvanceOnboardingResultModel — The result of creating a third party lead.
  - `leadId` string, uuid — Gets or sets the Lead Id.
  - `leadURL` string, nullable — Gets or sets the Lead redirect URL.
  - `signUpURL` string, nullable — Gets or sets the broker redirect URL.
  - `openBankingURL` string, nullable — Gets or sets the Open Banking Url.

## Other responses

- `400` — Bad Request
- `404` — Not Found

---

[API](https://skmtc.dev/youlend/apis/prequalification.md) · [All operations](https://skmtc.dev/youlend/apis/prequalification/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/youlend/prequalification/revisions/a76313c6cc3d/schema)