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
    • 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 Subclient Shareholders

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

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
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//business-users'

Responses

🟢200OK
application/json
success response
Body
ShareHolderOutputArray type
message
string 
optional
the response message
count
number 
optional
the data count
items
array[object (ShareHolderOutputData) {32}] 
optional
the response data object
businessUserId
string 
optional
The ID of the business user (optional).
entityId
string 
required
The ID
businessId
string 
optional
The ID of the associated business (optional).
title
string 
optional
The title of the user (required).
firstName
string 
required
The first name of the user (optional).
lastName
string 
required
The last name of the user (optional).
gender
string 
required
The gender of the user (optional).
dateOfBirth
string 
optional
The date of birth of the user (optional).
occupation
string 
optional
The occupation of the user (optional).
identificationType
string 
optional
The type of identification (optional).
identificationNumber
string 
optional
The identification number of the user (optional).
issuedDate
string 
optional
The date the identification was issued (optional).
expiryDate
string 
optional
The date the identification expires (optional).
bvn
string 
optional
The Bank Verification Number (optional).
isHonorInstructionFromUser
boolean 
optional
Indicates if the user's instruction should be honored (optional).
countryIso3Code
string 
optional
The ISO3 country code of residence.
country
string 
optional
The name of the country (optional).
address
string 
optional
The user's address (optional).
state
string 
optional
The state of residence (optional).
city
string 
optional
The city of residence (optional).
postalCode
string 
optional
The postal code of the address (optional).
contactEmail
string 
optional
The contact email (optional).
contactPhone
string 
optional
The contact phone number (optional).
meansOfIdentificationUrl
string 
optional
The means of identification image url.
proofOfAddressUrl
string 
optional
The proof of address image url
designation
enum<string> 
optional
Allowed values:
BeneficialOwnerDirectorBeneficialOwnerDirectorSignatoryBeneficialOwnerSignatoryDirectorSignatoryBeneficialOwnerDirectorSignatory
userRole
string 
optional
The role of the user in the system (optional).
shareholderPercentage
number 
optional
The percentage of shares owned by the shareholder (optional).
shareholderLevel
string 
optional
The level of the shareholder in the ownership structure (optional).
status
string 
optional
The current status of the client (default: ACTIVE).
parentType
enum<string> 
optional
Allowed values:
clientsubclient
isUbo
boolean 
required
Example
{
    "message": "string",
    "count": 0,
    "items": [
        {
            "businessUserId": "string",
            "businessId": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "gender": "string",
            "dateOfBirth": "string",
            "occupation": "string",
            "identificationType": "string",
            "identificationNumber": "string",
            "issuedDate": "string",
            "expiryDate": "string",
            "bvn": "string",
            "isHonorInstructionFromUser": true,
            "countryId": "string",
            "country": "string",
            "address": "string",
            "state": "string",
            "city": "string",
            "postalCode": "string",
            "contactEmail": "string",
            "contactPhone": "string",
            "meansOfIdentificationUrl": "string",
            "proofOfAddressUrl": "string",
            "designation": "BeneficialOwner",
            "userRole": "string",
            "shareholderPercentage": 0,
            "shareholderLevel": "string",
            "status": "string",
            "parentType": "client"
        }
    ]
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-03-19 09:22:29
Previous
Create Subclient Shareholder
Next
Update Subclient Shareholder
Built with