Create a lead.

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.

🚧

Be aware (USA)

  1. In the USA,employerIdentificationNumber param is mandatory
  2. 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")
📘

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.

string
required
length ≥ 1
string
required
length between 2 and 200
string
enum
required
length ≥ 1
string
required
length ≥ 1
string
required
length between 1 and 255
string
enum
required
length ≥ 1
registeredAddress
object
required
string
required
length between 8 and 20
string
required
length between 1 and 255
boolean
string | null
double
int32
double
int32
double
string | null
string | null
string | null
string | null
merchantIds
array of strings | null
merchantIds
additionalInfo
object | null
string | null
string | null
string | null
renewal
object
tradingAddress
object
string | null
uuid
uuid
string | null
enum
string | null
enum
Allowed:
secondaryLendingPartnerDetails
object
industries
array of objects | null
industries
Headers
string
string
enum
Defaults to application/json
Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json