Create Business Access Employee (User)

post

https://api.cloud.mbanq.com/v1/clients/{clientId}/linkedclients

Create a Business Access Employee (User) linked to a business customer.

This API provisions a self-service user who can log in to the platform and access/manage the associated business entity based on their assigned roles (e.g. Client Administrator). It registers the employee's personal attributes, assigned user roles, addresses, and document identifiers.

Path Params

clientId

integer

required

The business customer ID.

Body Params

dateFormat

string

Date format pattern used in the request payload.

locale

string

Preferred locale.

designation

string

Designation or job title of the employee.

firstname

string

required

First name of the employee.

lastname

string

required

Last name of the employee.

emailAddress

string

required

Email address of the employee used for self-service platform login.

dateOfBirth

string

Date of birth of the employee formatted according to dateFormat.

mobileCountryCode

string

Country calling code for the mobile number.

mobileNo

string

Mobile phone number of the employee.

roles

array of integers

required

Array of role IDs assigned to the employee user (e.g. Client Administrator ID).

roles*

genderId

integer

Gender code ID.

addresses

array of objects

List of address details for the employee.

addresses

identifiers

array of objects

List of identity document details for the employee.

identifiers

Headers

tenantId

string

required

The ID of your banking instance visible in the MBANQ Console.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200Business access employee created successfully.