For full country-specific configuration details, including enum values, field formats, and validation rules,
refer to the USA Localisation Guide section.
| Value | Description |
|---|---|
| BusinessCorporation | Corporation (Inc./Corp.; business corporation) |
| Llc | Limited liability company |
| Partnership | Business partnership |
| SoleTrader | Sole trader / self-employed individual |
Create Lead for United States of America
Here's a complete example of creating a lead for a US company using the Onboarding API:
{
"thirdPartyCustomerId": "US_CUSTOMER_12345",
"confirmedCreditSearch": true,
"countryISOCode": "USA",
"loanCurrencyISOCode": "USD",
"keyContactName": "Jordan Smith",
"companyType": "Llc",
"companyName": "Sunnyvale Supplies LLC",
"tradingName": "Sunnyvale Supplies",
"companyNumber": "1234567",
"companyWebsite": "https://sunnyvalesupplies.com",
"registeredAddress": {
"line1": "123 Market Street",
"city": "San Francisco",
"region": "California",
"areaCode": "94105",
"countryISOCode": "USA"
},
"contactPhoneNumber": "+14155550123",
"contactEmailAddress": "[email protected]",
"additionalInfo": {
"youLendSales": "false",
"language": "en_us"
}
}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.