Create Subclient - Multigate

Request

Path Params

clientId

string

required

Client's ID

Body Params application/json

SubClientInput type

subClientType

enum<string>

required

Subclient type

Allowed values:

subsidiaryclient

businessName

string

required

Name of the business

>= 1 characters<= 200 characters

Match pattern:

^[A-Za-z0-9&'()-.,/ :+$]+$

registrationNumber

string

optional

Registration number of the business

businessAddressLine1

string

required

The first line of the business address

businessAddressLine2

string

optional

The second line of the business address

businessContactEmail

string

required

Contact email for the business

businessContactPhone

string

optional

Contact phone number for the business

registrationDate

string

optional

Registration date of the business

countryOfRegistration

string

required

Country of registration for the business (ISO3 code)

operatingCountries

array[string]

required

List of countries where the business operates (ISO3 code)

operatingIndustries

array[string]

optional

List of industries in which the business operates

city

string

required

City where the business is located

state

string

required

State where the business is located

postalCode

string

required

Postal code of the business address

tin

string

optional

Tax Identication Number

customerType

enum<string>

optional

Customer type

Allowed values:

corporatefinancialInstitution

businessType

enum<string>

required

Business type

Allowed values:

Public Limited CompanyLimited Liability CompanyOrdinary Business RegistrationGovernment Agency

Example

{
  "subClientType": "string",
  "businessName": "string",
  "registrationNumber": "string",
  "businessAddressLine1": "string",
  "businessAddressLine2": "string",
  "businessContactPhone": "string",
  "businessContactEmail": "string",
  "countryOfRegistration": "string",
  "registrationDate": "string",
  "operatingCountries": [
    "string"
  ],
  "operatingIndustries": [
    "string"
  ],
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "tin": "string",
  "customerType": "string",
  "businessType": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/clients//sub-clients' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subClientType": "string",
    "businessName": "string",
    "registrationNumber": "string",
    "businessAddressLine1": "string",
    "businessAddressLine2": "string",
    "businessContactPhone": "string",
    "businessContactEmail": "string",
    "countryOfRegistration": "string",
    "registrationDate": "string",
    "operatingCountries": [
        "string"
    ],
    "operatingIndustries": [
        "string"
    ],
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "tin": "string",
    "customerType": "string",
    "businessType": "string"
}'

Responses

🟢200OK

application/json

success response

Body

SubClientOutputData type

entityId

string

optional

The unique identifier for the subclient.

name

string

optional

The name of the subclient.

subClientType

string

optional

The type of subclient e.g. 'subsidiary', 'client'

businessContactPhone

string

optional

The contact phone number for the business.

businessContactEmail

string

optional

The contact email for the business.

countryOfRegistration

string

optional

The country where the business is registered.

stagesRemaining

array[string]

optional

Array listing the stages remaining in the process.

approvalStatus

string

optional

Maker/checker approval status (this can be ignored for API users)

businessName

string

optional

The registered name of the business.

registrationDate

string

optional

The date the business was registered.

businessAddressLine1

string

optional

The first line of the business's address.

operatingCountries

array[string]

optional

Countries where the business operates.

operatingIndustries

array[string]

optional

Industries in which the business operates.

status

enum<string>

optional

The current status of the subclient

Allowed values:

draftprocessingactiveinactiveblocked

createdAt

string

optional

The date the subclient record was created.

updatedAt

string

optional

The date the subclient record was last updated

parentClientId

string

optional

The unique identifier of the parent client

approvalComments

string

optional

Maker/checker approval comments (this can be ignored for API users)

approvalDate

string

optional

Maker/checker approval date (this can be ignored for API users)

Example

{
  "data": {
    "entityId": "string",
    "name": "string",
    "subClientType": "string",
    "businessContactPhone": "string",
    "businessContactEmail": "string",
    "countryOfRegistration": "string",
    "stagesRemaining": [
      "string"
    ],
    "approvalStatus": "string",
    "businessName": "string",
    "registrationDate": "string",
    "businessAddressLine1": "string",
    "operatingCountries": [
      "string"
    ],
    "operatingIndustries": [
      "string"
    ],
    "status": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "parentClientId": "string",
    "approvalComments": "string",
    "approvalDate": "string"
  }
}

🟠400Bad Request

🟠401Unauthorized