Multigate
  1. 👋 Onboarding
Multigate
  • 🚀 Getting Started
  • 🔓 Authentication
    • Get Token
    • Refresh Token
    • Logout User
    • Reset Password
    • Get Current User Info
  • 👋 Onboarding
    • Create Subclient
      POST
    • Get All Subclients
      GET
    • Get Subclient
      GET
    • Update Subclient
      PATCH
    • Create Subclient Shareholder
      POST
    • Get Subclient Shareholders
      GET
    • Update Subclient Shareholder
      PATCH
    • Upload Subclient Documents
      POST
    • Get Subclient Documents
      GET
    • Delete Subclient
      PATCH
    • Submit Subclient
      POST
  • 💰 Accounts
    • 📄 Statements
      • Get Statement
      • Download statement
    • Create Virtual Account
    • Get Account
    • Get Accounts By
    • Get All Accounts
    • Simulate Inflow (UAT only)
  • 🔃 Conversions
    • Get Quote
    • Lock Rate
    • Get Trade
    • Get All Trades
  • 💸 Payments
    • 🏦 Banks
      • Get Bank Details
    • 👤 Beneficiaries
      • Create Beneficiary
      • Get All Beneficiaries
      • Get Beneficiary
      • Update Beneficiary
      • Validate Beneficiary Account (NGN only)
    • Create Single Transfer
    • Get Purpose Codes
    • Get Transfer Fields & Fees
    • Find Transfers
  • 📩 Webhooks / Push Notifications
    • Add a New Client Configuration
    • Update Client Configuration Current Mode
    • Get Client Configuration
  • 📲 Remittance
    • Initiate Remittance
    • Get Remittance
  1. 👋 Onboarding

Get All Subclients

GET
/client-service/api/v1/clients/{clientId}/sub-clients

Request

Path Params

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/clients//sub-clients?pageSize&pageOffset&sortField&sortDirection'

Responses

🟢200OK
application/json
success response
Body

Example
{
    "message": "Sub-Client fetched successfully",
    "data": [
        {
            "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",
            "tin": null,
            "postalCode": "101233"
        },
        {
            "entityId": "uEhjFhsDM0QvyscEwkqlt",
            "name": "Yost-Wiza",
            "subClientType": "client",
            "businessContactPhone": "+8860192889928",
            "businessContactEmail": "yost-wiza@yopmail.com",
            "countryOfRegistration": "BEL",
            "stagesRemaining": [
                "documentation",
                "director"
            ],
            "approvalStatus": "approved",
            "businessName": "Yost-Wiza",
            "registrationDate": null,
            "businessAddressLine1": "Yost-Wiza Estate",
            "businessAddressLine2": "Tom Tom",
            "operatingCountries": [
                "BEL"
            ],
            "operatingIndustries": null,
            "status": "processing",
            "city": "Taiwan",
            "state": "Belgium",
            "customerType": "financialInstitution",
            "businessType": "Limited Liability Company",
            "createdAt": "2025-04-22T17:04:30.879Z",
            "updatedAt": "2025-04-24T06:43:58.335Z",
            "tin": "TIN092-837",
            "postalCode": "100001"
        },
        {
            "entityId": "ATzllZDVSHg61T0ADQFqb",
            "name": "UAT defect retest",
            "subClientType": "subsidiary",
            "businessContactPhone": "+2343564567",
            "businessContactEmail": "uatdefectretest@yopmail.com",
            "countryOfRegistration": "NGA",
            "stagesRemaining": [],
            "approvalStatus": "approved",
            "businessName": "UAT defect retest",
            "registrationDate": null,
            "businessAddressLine1": "195 North White Old Lane",
            "businessAddressLine2": "Et enim libero volup",
            "operatingCountries": [
                "NGA"
            ],
            "operatingIndustries": null,
            "status": "active",
            "city": "Ibadan",
            "state": "Oyo",
            "customerType": null,
            "businessType": "Public Limited Company",
            "createdAt": "2025-04-14T10:27:04.505Z",
            "updatedAt": "2025-04-14T11:27:06.890Z",
            "tin": null,
            "postalCode": "Quod qui eos invent"
        },
        {
            "entityId": "vGLRsu_-UkG-D9MmcVutP",
            "name": "Hilll and Sons",
            "subClientType": "subsidiary",
            "businessContactPhone": "+2348883395921",
            "businessContactEmail": "Ben.Jamel.Walsh@yopmail.com",
            "countryOfRegistration": "NGA",
            "stagesRemaining": [],
            "approvalStatus": "approved",
            "businessName": "Hilll and Sons",
            "registrationDate": "2025-04-11",
            "businessAddressLine1": "1756 Jerry Villages",
            "businessAddressLine2": "68744 Daniel Walks",
            "operatingCountries": [
                "USA",
                "NGA"
            ],
            "operatingIndustries": [
                "IT",
                "Real Estate"
            ],
            "status": "active",
            "city": "Lagos",
            "state": "Lagos",
            "customerType": null,
            "businessType": "Limited Liability Company",
            "createdAt": "2025-04-11T14:08:11.666Z",
            "updatedAt": "2025-04-11T15:08:54.111Z",
            "tin": null,
            "postalCode": "100002"
        },
        {
            "entityId": "bTGENhOHBo95ZxdK4tqAh",
            "name": "Mertz Group",
            "subClientType": "subsidiary",
            "businessContactPhone": "07069039756",
            "businessContactEmail": "loafy@yopmail.com",
            "countryOfRegistration": "USA",
            "stagesRemaining": [],
            "approvalStatus": "pending",
            "businessName": "Mertz Group",
            "registrationDate": "2023-02-29",
            "businessAddressLine1": "Norway Venue 2000",
            "businessAddressLine2": "Macmillian 2849 Cresent",
            "operatingCountries": [
                "USA",
                "NGA"
            ],
            "operatingIndustries": [
                "IT",
                "Real Estate"
            ],
            "status": "draft",
            "city": "Lagos",
            "state": "Lagos",
            "customerType": null,
            "businessType": "Public Limited Company",
            "createdAt": "2025-04-11T14:04:51.558Z",
            "updatedAt": "2025-04-11T15:06:25.761Z",
            "tin": null,
            "postalCode": "100002"
        },
        {
            "entityId": "2mvy2NMj0-1w4iHvBpeom",
            "name": "UAT Subclient",
            "subClientType": "subsidiary",
            "businessContactPhone": "+23408013457830",
            "businessContactEmail": "uatsubclientuser@yopmail.com",
            "countryOfRegistration": "NGA",
            "stagesRemaining": [],
            "approvalStatus": "approved",
            "businessName": "UAT Subclient",
            "registrationDate": null,
            "businessAddressLine1": "1, Busy Street",
            "businessAddressLine2": "",
            "operatingCountries": [
                "NGA"
            ],
            "operatingIndustries": null,
            "status": "active",
            "city": "Lagos",
            "state": "Lagos",
            "customerType": null,
            "businessType": "Limited Liability Company",
            "createdAt": "2025-04-03T02:08:06.009Z",
            "updatedAt": "2025-04-03T03:09:03.564Z",
            "approvalComments": "Approved by Lateef",
            "approvalDate": "Thu Apr 03 2025 04:09:03 GMT+0100 (West Africa Standard Time)",
            "tin": null,
            "postalCode": "100001"
        },
        {
            "entityId": "pBXJdbzdL1pwm_jysGBao",
            "name": "Deckow, Kessler and Reilly",
            "subClientType": "subsidiary",
            "businessContactPhone": "+2348522004440",
            "businessContactEmail": "Kristopher.Hettie.Hyatt@yopmail.com",
            "countryOfRegistration": "NGA",
            "stagesRemaining": [],
            "approvalStatus": "approved",
            "businessName": "Deckow, Kessler and Reilly",
            "registrationDate": "2025-04-01",
            "businessAddressLine1": "48832 Edna Ramp",
            "businessAddressLine2": "3437 Kaelyn Flats",
            "operatingCountries": [
                "USA",
                "NGA"
            ],
            "operatingIndustries": [
                "IT",
                "Real Estate"
            ],
            "status": "active",
            "city": "Lagos",
            "state": "Lagos",
            "customerType": null,
            "businessType": "Limited Liability Company",
            "createdAt": "2025-04-01T16:45:13.777Z",
            "updatedAt": "2025-04-01T17:47:16.384Z",
            "approvalComments": "Approved by Lateef",
            "approvalDate": "Tue Apr 01 2025 18:47:16 GMT+0100 (West Africa Standard Time)",
            "tin": null,
            "postalCode": "100002"
        },
        {
            "entityId": "o9sfxB4Q0wyRD52G81Wwr",
            "name": "UAT Subclient",
            "subClientType": "subsidiary",
            "businessContactPhone": "+23408021112132",
            "businessContactEmail": "smsubclientuser@yopmail.com",
            "countryOfRegistration": "NGA",
            "stagesRemaining": [],
            "approvalStatus": "approved",
            "businessName": "UAT Subclient",
            "registrationDate": null,
            "businessAddressLine1": "1 Busy Street",
            "businessAddressLine2": "",
            "operatingCountries": [
                "NGA"
            ],
            "operatingIndustries": null,
            "status": "active",
            "city": "Lagos",
            "state": "Lagos",
            "customerType": null,
            "businessType": "Limited Liability Company",
            "createdAt": "2025-04-01T15:18:26.946Z",
            "updatedAt": "2025-04-03T15:54:33.969Z",
            "approvalComments": "approved",
            "approvalDate": "Thu Apr 03 2025 16:54:33 GMT+0100 (West Africa Standard Time)",
            "tin": null,
            "postalCode": "100001"
        },
        {
            "entityId": "UJBTC6o-fYBHtPGntDH3u",
            "name": "FE Subclient 1",
            "subClientType": "subsidiary",
            "businessContactPhone": "+23408011122233344",
            "businessContactEmail": "fesubclient1user@yopmail.com",
            "countryOfRegistration": "NGA",
            "stagesRemaining": [],
            "approvalStatus": "approved",
            "businessName": "FE Subclient 1",
            "registrationDate": null,
            "businessAddressLine1": "1 Busy Street",
            "businessAddressLine2": "1 Busy Street",
            "operatingCountries": [
                "NGA"
            ],
            "operatingIndustries": null,
            "status": "approved",
            "city": "Lagos",
            "state": "Lagos",
            "customerType": null,
            "businessType": "Limited Liability Company",
            "createdAt": "2025-03-30T17:23:11.870Z",
            "updatedAt": "2025-03-30T18:23:21.254Z",
            "tin": null,
            "postalCode": "100001"
        },
        {
            "entityId": "KjJlx3IEZXVMara9FeirZ",
            "name": "Hyatt and Sons",
            "subClientType": "subsidiary",
            "businessContactPhone": "+2348283482901",
            "businessContactEmail": "Ethan.Juliet.Moore@yopmail.com",
            "countryOfRegistration": "NGA",
            "stagesRemaining": [],
            "approvalStatus": "approved",
            "businessName": "Hyatt and Sons",
            "registrationDate": "2025-03-27",
            "businessAddressLine1": "33383 Enrique Drives",
            "businessAddressLine2": "20410 Nienow Bridge",
            "operatingCountries": [
                "USA",
                "NGA"
            ],
            "operatingIndustries": [
                "IT",
                "Real Estate"
            ],
            "status": "active",
            "city": "Lagos",
            "state": "Lagos",
            "customerType": null,
            "businessType": "Limited Liability Company",
            "createdAt": "2025-03-27T14:43:04.499Z",
            "updatedAt": "2025-03-27T15:45:26.819Z",
            "approvalComments": "Approved by Lateef",
            "approvalDate": "Thu Mar 27 2025 16:45:26 GMT+0100 (West Africa Standard Time)",
            "tin": null,
            "postalCode": "100002"
        }
    ],
    "totalItems": 21,
    "pageSize": null,
    "currentPage": null,
    "totalPages": null
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-01-28 21:04:23
Previous
Create Subclient
Next
Get Subclient
Built with