Create Client Lead Via API without documents

post

https://api.sandbox.toq.io/iam/api/customers/{customerId}/clients/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

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.

billingModelId

string

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

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK