Create user

post

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

Allows to create a user under a client

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

clientId

string

required

Body Params

When selecting overrideCompliance true OR overrideCompliance false and runKYC true for SME REGISTERED clients, you can provide some information if you have it in advance about the company you want to onboard. All the DIRECTORS of the company MUST be added and will be required to do a KYC validation process by sending a live photo of their personal documentation and a selfie or a video, depending on the legislationCountry selection (e.g., if legislationCountry is UK this will be a selfie, if legislationCountry ES it will be a video). These DIRECTORS, in addition to the main user created in the OnboardingUserDTO, will go through this process to be reviewed in our compliance partner (overrideCompliance false) OR just saved to collect the information provided (overrideCompliance true AND runKYC true).

firstName

string

required

Minimum required informatiom to create a user.

lastName

string

required

Minimum required informatiom to create a user.

string

required

phoneNumber

string

required

You MUST add a mobile phone. By adding a landline the request will be rejected.

phoneCountry

string

required

You MUST add the country prefix. We will send an OTP SMS message when the user is setting up the credentials.

consultancy

string

role

string

enum

required

SME roles: ROLE_DIRECTOR, ROLE_COMPANY_ADMIN, ROLE_EMPLOYEE, ROLE_ACCOUNTANT and ROLE_AGENT; Consumer roles: ROLE_OWNER and ROLE_BENEFICIARY.

Allowed:

birthDate

string

required

Minimum required informatiom to create a user.

country

string

required

postalCode

string

required

address

string

required

length between 0 and 1000

Minimum required informatiom to create a user.

address2

string

length between 0 and 1000

Minimum required informatiom to create a user.

city

string

required

cardType

string

enum

Allowed:

cardDeliveryName

string

cardDeliveryAddress

object

nameOnCard

string

otp

string

personalIdentityNumber

string

documentType

string

documentNumber

string

tin

string

length between 0 and 11

documentIssueDate

string

sendInvite

boolean

required

When the 'sendInvite' parameter is set to 'true', the newly created user will receive an email invitation to set up their credentials. If 'sendInvite' is set to 'false', no email will be sent. If 'sendInvite' is left empty, the system will automatically set it to 'true' by default.

metadata

object

Key→value map.
• Must be an object
• Cannot be a primitive

Response

200OK