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

Create Subclient Shareholder

POST
/client-service/api/v1/clients/{clientId}/sub-clients/{id}/business-users
Create a single shareholder (business user) for a subclient.

Request

Path Params
clientId
string 
required
Client's ID
id
string 
required
SubClient's ID
Body Params application/json
CreateShareHolderInput type
title
string 
required
The title of the shareholder e.g. Mr, Mrs
firstName
string 
required
The first name of the shareholder
lastName
string 
required
The last name of the shareholder
gender
string 
required
The gender of the shareholder
Examples:
malefemale
occupation
string 
required
The occupation of the shareholder
Example:
Product Manager
identificationType
enum<string> 
required
The type of identification (must be one of the predefined types)
Allowed values:
IDCARD ID PASSPORT VISA FUND_SOURCE RESIDENCE_PERMIT PROOF_OF_ADDRESS OTHER RECENT_BANK PROFESSIONAL_CERTIFICATE ESTATE_PROOF AML_REPORT AML_CERTIFICATE ID_VERIFICATION_REPORT LIVENESS_CHECK_VIDEO INDIVIDUAL_PROOF_BUNDLE FACE_PHOTO NIN VOTERS_CARD DRIVER_LICENSE DRIVERS_LICENSE
identificationNumber
string 
required
The identification number for the shareholder
countryIso3Code
string 
required
The ID of the country where the shareholder resides
issuedDate
string 
required
The date the identification was issued
expiryDate
string 
optional
The date the identification expires
bvn
string 
optional
Bank Verification Number
country
string 
required
The name of the country
address
string 
required
The address of the shareholder
city
string 
required
The city where the shareholder resides
state
string 
required
The state where the shareholder resides
postalCode
string 
required
The postal code of the shareholder's address
dateOfBirth
string 
required
The date of birth of the user
contactEmail
string 
optional
The contact email of the shareholder
contactPhone
string 
optional
The contact phone number of the shareholder
meansOfIdentificationUrl
string 
optional
The means of identification image URL
proofOfAddressUrl
string 
optional
The proof of address image URL
designation
enum<string> 
required
Shareholder designation
Allowed values:
BeneficialOwnerDirectorBeneficialOwnerDirectorSignatoryBeneficialOwnerSignatoryDirectorSignatoryBeneficialOwnerDirectorSignatory
shareholderPercentage
number 
optional
The percentage of ownership held by the shareholder (optional, required based on designation)
shareholderLevel
string 
optional
The level of the shareholder in the ownership structure (optional, required based on designation)
isUbo
boolean 
optional
Example
{
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": "male",
    "occupation": "Product Manager",
    "identificationType": " IDCARD",
    "identificationNumber": "string",
    "countryIso3Code": "string",
    "issuedDate": "string",
    "expiryDate": "string",
    "bvn": "string",
    "country": "string",
    "address": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "dateOfBirth": "string",
    "contactEmail": "string",
    "contactPhone": "string",
    "meansOfIdentificationUrl": "string",
    "proofOfAddressUrl": "string",
    "designation": "BeneficialOwner",
    "shareholderPercentage": 0,
    "shareholderLevel": "string",
    "isUbo": true
}

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 POST 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/clients//sub-clients//business-users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": "male",
    "occupation": "Product Manager",
    "identificationType": " IDCARD",
    "identificationNumber": "string",
    "countryIso3Code": "string",
    "issuedDate": "string",
    "expiryDate": "string",
    "bvn": "string",
    "country": "string",
    "address": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "dateOfBirth": "string",
    "contactEmail": "string",
    "contactPhone": "string",
    "meansOfIdentificationUrl": "string",
    "proofOfAddressUrl": "string",
    "designation": "BeneficialOwner",
    "shareholderPercentage": 0,
    "shareholderLevel": "string",
    "isUbo": true
}'

Responses

🟢200OK
application/json
success response
Body
ShareHolderOutputData type
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": "Sub-Client user created successfully",
    "id": "239",
    "entityId": "qaLGyVaQMSKXPKdYwqww2",
    "createdAt": "2025-05-29T16:48:14.100Z",
    "updatedAt": "2025-05-29T16:48:14.100Z",
    "createdBy": "abc.def@yopmail.com",
    "updatedBy": null,
    "isDeleted": false,
    "businessUserId": null,
    "businessId": null,
    "title": "Prof",
    "firstName": "Furman",
    "lastName": "Howell",
    "gender": "Male",
    "dateOfBirth": "1991-03-01",
    "occupation": "System Engineer",
    "identificationType": "PASSPORT",
    "identificationNumber": "ITBIACX1",
    "issuedDate": "2024-09-01",
    "expiryDate": null,
    "bvn": null,
    "isHonorInstructionFromUser": null,
    "countryId": null,
    "countryIso3Code": "NGA",
    "country": "Nigeria",
    "address": "2375 Camron Spring",
    "state": "Lagos",
    "city": "Lagos",
    "postalCode": "10001",
    "contactEmail": null,
    "contactPhone": null,
    "meansOfIdentificationUrl": null,
    "proofOfAddressUrl": null,
    "designation": "BeneficialOwner",
    "userRole": null,
    "shareholderPercentage": 80,
    "shareholderLevel": "Intermediate",
    "isUbo": false,
    "status": "active"
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-05-30 05:54:31
Previous
Update Subclient
Next
Get Subclient Shareholders
Built with