For full country-specific configuration details, including enum values, field formats, and validation rules,
refer to the UK Localisation Guide section.
| Value | Description |
|---|---|
| Llp | Limited liability partnership |
| Ltd | Private limited company |
| Partnership | Business partnership |
| Plc | Public limited company |
| SoleTrader | Sole trader / self-employed individual |
Create Lead for United Kingdom
Here's a complete example of creating a lead for a UK company using the Onboarding API:
{
"thirdPartyCustomerId": "GB_CUSTOMER_12345",
"confirmedCreditSearch": true,
"countryISOCode": "GBR",
"loanCurrencyISOCode": "GBP",
"keyContactName": "Sophie Allard",
"companyType": "Ltd",
"companyName": "Acme Retail Ltd",
"tradingName": "Acme Retail",
"companyNumber": "07538765",
"companyWebsite": "https://acmeretail.co.uk",
"registeredAddress": {
"line1": "221B Baker Street",
"city": "London",
"region": "Greater London",
"areaCode": "NW1 6XE",
"countryISOCode": "GBR"
},
"contactPhoneNumber": "+447912345678",
"contactEmailAddress": "[email protected]",
"additionalInfo": {
"youLendSales": "false",
"language": "en"
}
}Response
{
"leadId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"leadURL": "string",
"signUpURL": "string",
"openBankingURL": "string"
}The API will return a leadId that you can use for subsequent operations like uploading documents, updating organization details, or retrieving lead status.