API Reference

Update organisation details.

put
https://partners.staging-youlendapi.com/onboarding/Leads//organisationdetails
🚧

FAQ

confirmedCreditSearch is a boolean. Not populating this field when sending this PUT will set confirmedCreditSearch to false - even if it was previously set to true.

Path Params
uuid
required

The lead id.

Body Params

Model for details for the company.

Model for organisation details for a company.

string
required
length between 2 and 200

Gets or sets the merchant's company name.

registeredAddress
object
required

Address Data Model.

string
enum
required
length ≥ 1

Gets or sets the country for the company.

date-time

Gets or sets the formation date of the company.

string
required
length between 1 and 255

Gets or sets the key merchant contact who will be setting up the loan.

string
required
length between 8 and 20

Gets or sets the merchant's contact phone number.

string
required
length between 1 and 255

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

tradingAddress
object

Address Data Model.

string | null

Gets or sets the merchant's trading name.

string | null

Gets or sets the registered company number.

string | null

Gets or sets the VAT number for the company.

string
enum

Gets or sets the key merchant company type.

string | null

Gets or sets the description for the company.

string | null

Gets or sets the merchant's company website URL.

industries
array of objects | null

Gets or sets the list of industries in which the company conducts business.

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

string | null

Gets or sets the merchants tax identification number (required for USA).

Headers
string
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
204

No Content

Updated 2 months ago

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

Updated 2 months ago