v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB
Enrich an Application

Update organisation details.

put/Leads/{leadId}/organisationdetails

Path parameters

leadIdstring uuid required

The lead id.

Headers

api-versionstring

Request body

companyNamestring required

Gets or sets the merchant's company name.

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

Gets or sets the country for the company.

formationDatestring date-time

Gets or sets the formation date of the company.

keyContactNamestring required

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

contactPhoneNumberstring required

Gets or sets the merchant's contact phone number.

contactEmailAddressstring email required

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

tradingNamestring nullable

Gets or sets the merchant's trading name.

companyNumberstring nullable

Gets or sets the registered company number.

vatNumberstring nullable

Gets or sets the VAT number for the company.

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'

Gets or sets the key merchant company type.

descriptionstring nullable

Gets or sets the description for the company.

companyWebsitestring nullable

Gets or sets the merchant's company website URL.

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

employerIdentificationNumberstring nullable

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

Response

No Content