Get Subclient - Multigate

Request

Path Params

clientId

string

required

Client's ID

id

string

required

SubClient's ID

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/clients//sub-clients/'

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

city

string

optional

state

string

optional

customerType

string

optional

businessType

string

optional

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

postalCode

string

optional

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

{
    "message": "Sub-Client fetched successfully",
    "entityId": "mD2XvNRvG_Q973StnNOoM",
    "name": "UAT Client Subclient 3",
    "subClientType": "subsidiary",
    "businessContactPhone": "+23417033288504",
    "businessContactEmail": "ayodele1@yopmail.com",
    "countryOfRegistration": "NGA",
    "stagesRemaining": [],
    "approvalStatus": "approved",
    "businessName": "UAT Client Subclient 3",
    "registrationDate": null,
    "businessAddressLine1": "16c Ruxton Road, Ikoyi, Lagos",
    "businessAddressLine2": null,
    "operatingCountries": [
        "NGA"
    ],
    "operatingIndustries": null,
    "status": "processing",
    "city": "Ikoyi",
    "state": "Lagos",
    "customerType": null,
    "businessType": "Limited Liability Company",
    "createdAt": "2025-05-09T11:06:34.330Z",
    "updatedAt": "2025-05-09T12:06:39.136Z",
    "parentClientId": "9va0EY5wREalB8ESQRdgo",
    "callbackUrl": null,
    "tin": null,
    "postalCode": "101233"
}

🟠400Bad Request

🟠401Unauthorized