Add Client
Add Client (sub-user)
You can add sub-user to your account, to enable them have a separate account only to be linked to your master account. With this, you can have some services created for them like Virtual account to their available wallet.
POST METHOD
{{baseUrl}}api/v2/clients
{
"email" : "[email protected]",
"firstName":"John",
"lastName":"Doe",
"userType":1,
"companyName":"",
"sex":"Male",
"mobile":"8080808080",
"mobileCode":"+234",
"dob":"23-05-1998",
"country":"Nigeria",
"countryCode":"NG",
"address":"Somewhere in lagos",
"city":"Lekki",
"state":"Lagos",
"zipcode":"23402",
"employmentStatus" : "Employed",
"occupation" : "Civil Servant",
"sourceOfFund" : "Business",
"incomeRange" : "1-10000",
"accountDesignation" : "Personal"
}
| Field | Required | Data Type | Description |
|---|---|---|---|
| true | Sub User Email Address | ||
| firstName | true | String | Sub User First Name i.e John |
| lastName | true | String | Sub User First Name i.e Doe |
| userType | true | integer | Sub User Account Type (1 => Individual Account , 2 => Business account) |
| companyName | - | String | Sub User Company Name (required if userType is 2) |
| sex | true | String | Sub User Gender |
| mobile | true | String | Mobile Number |
| mobileCode | true | String | Sub User Country Mobile Code i.e Oyo-NIG32 |
| dob | true | date | Sub User Date of Birth i.e 23-05-1998 |
| address | true | string | Sub User resident address |
| state | true | string | Sub users resident state |
| city | true | string | Resident City of Beneficiary. Check City endpoint to get cityID and cityName, supply both cityID and cityName i.e IBADAN-25181 |
| country | true | string | Sub users country |
| countryCode | true | string | Sub users country ISO code i.e US, CA. |
| employmentStatus | true | string | Employed or Not Employed |
| occupation | true | string | Self Employed, Civil Servant, Student |
| sourceOfFund | true | string | Pick from |
| incomeRange | true | string | "1-10000", "10001-100000", ... |
| accountDesignation | true | string | Personal or Business |
Response
{
"status": true,
"content": {
"data": {
"endUser": {
"username": "rv1-1661349202",
"email": "[email protected]",
"level": 0,
"emailVerify": 1,
"referral": 3,
"id": 31,
"pix": null,
"firstName": "Dawe",
"lastName": "John",
"dob": "1998/05/23",
"sex": "Male",
"address": "somehwere around the world",
"state": "Lagos",
"stateCode": null,
"city": "Lekki",
"zipcode": "",
"country": "Nigeria",
"countryCode": "NG",
"mobileCode": "+234",
"mobile": "8080808080",
"userType": 1,
"companyName": "",
"created_at": "2022-08-24T13:53:22.000000Z",
"updated_at": "2022-08-24T13:53:22.000000Z",
},
"wallet": [
{
"id": 113,
"cur": "NGN",
"balance": 0,
"created_at": "2022-08-24T13:53:22.000000Z",
"updated_at": "2022-08-24T13:53:22.000000Z",
"currency": "Naira",
"country": "Nigeria",
"countryCode": "NG",
"flag": "https://qwid.io/assets/svg/flag/ng.svg"
},
{
"id": 116,
"cur": "USD",
"balance": 0,
"created_at": "2022-08-24T13:53:22.000000Z",
"updated_at": "2022-08-24T13:53:22.000000Z",
"currency": "Dollar",
"country": "United State Of America",
"countryCode": "US",
"flag": "https://qwid.io/assets/svg/flag/us.svg"
},
{
"id": 115,
"cur": "GBP",
"balance": 0,
"created_at": "2022-08-24T13:53:22.000000Z",
"updated_at": "2022-08-24T13:53:22.000000Z",
"currency": "Pounds",
"country": "United Kingdom",
"countryCode": "UK",
"flag": "https://qwid.io/assets/svg/flag/gb.svg"
},
{
"id": 114,
"cur": "EUR",
"balance": 0,
"created_at": "2022-08-24T13:53:22.000000Z",
"updated_at": "2022-08-24T13:53:22.000000Z",
"currency": "Euro",
"country": "Europe",
"countryCode": "EU",
"flag": "https://qwid.io/assets/svg/flag/eu.svg"
}
],
"kyc": {
"status": false,
"verificationLink": "https://signup.getmati.com/?merchantToken=629a22873eb640001c5dc1e0&flowId=62ebce4b06f1e1001c505dc7&metadata=%7B%22fixedLanguage%22%3A%22en%22%2C%22user_id%22%3A%22dawesr%40boximail.com%22%2C%22userType%22%3A1%7D"
}
}
}
}
Verification Process
Client Verification Process
After creating of client (sub-user), user need to do KYC/KYB verification using the link provided after account creation.
"kyc": { "status": false, "verificationLink": "<https://signup.getmati.com/?merchantToken=629a22873eb640001c5dc1e0&flowId=62ebce4b06f1e1001c505dc7&metadata=%7B%22fixedLanguage%22%3A%22en%22%2C%22user_id%22%3A%22dawesr%40boximail.com%22%2C%22userType%22%3A1%7D>" }
User Type Document Type Individual Identity Document Int'l Passport, Driver License, National ID, Proof of Address Statement of Account, Utility Bills, ... Business Identity Document (representative) Int'l Passport, Driver License, National ID, Proof of Address (representative) Statement of Account, Utility Bills, ... Business Certificate Memorandum Proof of Address (Company) Shareholder ID and Proof of Address Shareholder with at least 20%
Updated over 1 year ago