Create Client Lead Via API

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Path Params

customerId

string

required

customerId

Body Params

createCompanyLeadViaApiDTO

This is the main endpoint to create a new lead.

customerId

string

We will provide you with a costumer id to be placed in this field. If you don't have it, please get in touch with [email protected]

client

object

A client is the top object, containing users. It can be a corporate or an individual, in the case of consumer users or sole traders. A client has a main user which must be created at the time of creating the client. This main user will be invited to set up the credentials and join the application.

user

object

This is the information you must provide for the main user of the client. This is mandatory for any organisationType, regardless of being SME or CONSUMER.

overrideCompliance

boolean

Select true if you don't need the client going over the compliance process. This will only work for compliance providers that permit the use of the override process. Use carefully and only if you already have run a compliance process over the client.

runKYC

boolean

Works only for TRUNARRATIVE compliance process. If in the field above, overrideCompliance, you have selected true, you still can ask the user for company and personal information to be collected for monitoring. When selecting this option as true, the client will be asked for the compliance information but won't go thru a compliance process and will be automatically onboarded.

sendInvite

boolean

Select true if you want to send an invite to the main user of the client. If you select false, it will store the data and you could invite the lead later at your convenience from the admin portal.

billingModelId

string

Add the id of the billing model you want to apply to the customer.

directors

array of objects

directors

shareholders

array of objects

shareholders

documents

array of objects

documents

200OK