Account Administrators

Add Account Administrator for SME

POST /account/v2/addAccountAdministrator

Use this endpoint to add a new account administrator for an SME customer.

NOTE: To add a new account manager, only the OTP confirmation from account owner is needed. And once the OTP is verified, the new account manager is added. The mobile and email status of the new account manager are by default UNVERIFIED until they call the API /account/verifyAccountAdministrator to verify the mobile or the email respectively.

Parameters

Parameters	Type	Description	Is Required
accountId	string	The account that the account administrator will be have access to/allowed to make operations on.	TRUE
idType	string	Type of the document. 101 - (Kenya) National ID 102 - (Kenya) Alien ID 103 - Passport	TRUE
idNumber	string	ID number of the administrator	TRUE
fullName	string	full name of the administrator	TRUE
countryCode	string	Country code of the administrator's mobile. E.g. 254	TRUE
mobile	string	mobile number of the administrator	TRUE
email	string	Email address of the administrator	TRUE

Response

00000

{
  "accAdminRequestId": ""
}

Verify Account Administrator

POST /account/verifyAccountAdministrator

This endpoint is used to verify the email/mobile of an added account manager to allow them to receive and verify OTP for business onboardings and transactions.

When an account administrator has been added (but not verified yet), he/she can call this API to verify their email or mobile. Only after verifying will the the account administrator be ready to make transfers and validate all other applicable operations which require OTP validation.

Parameters

Parameters	Type	Description	Is Required
accountId	string	The account that the account administrator will have access to/be allowed to make operations on.	TRUE
idType	string	Type of the document. 101 - (Kenya) National ID 102 - (Kenya) Alien ID 103 - Passport	TRUE
idNumber	string	ID number of the administrator	TRUE
verifyType	string	EMAIL MOBILE	TRUE

Response

00000

{
  "applicationId": ""
}

Query Account Administrator List

POST /account/queryAccountAdministrator

Use this endpoint to query account managers of SME account.

Parameters	Type	Description	Required?
accountId	string	The account number of the SME which you want to query the list of account managers.	TRUE

Response

00000

"data": {
    "accountManagerInfos":[
    //Array of Object, array of the detailed information of the account managers.
        {
            "accountId": "", //String, SME account Id
            "fullName": "", //String, full name of the account manager which is submitted when added  
            "email": "", //String, email of the account manager.
            "countryCode": "", //String, phone country code, "254" for Kenya
            "mobile": "", //String, mobile number of the account manager
            "idType":"", //String, Identity document ID type
            "idNumber":"", //String, Identity Number 
            "emailVerified":"", //Integer, 0 is unverified, 1 is verified
            "mobileVerified":"", //Integer,  0 is unverified, 1 is verified 
            "createTime": 1234567890, //Long, unix timestamp of the time the account manager was added.
            "updateTime": 1234567890 //Long, unix timestamp of the time when the account manager was updated.     
        },{}
    ]
}

Remove Account Administrator

POST /account/removeAccountAdministrator

Use this endpoint to remove an account administrator from a particular account.

Parameters

Parameters	Type	Description	Required?
accountId	string	Account number	TRUE
countryCode	string	Account administrator's mobile's country code	FALSE
mobile	string	Mobile number of administrator to be removed	FALSE
idType	string	Type of the document of the account administrator that is to be removed. 101 - (Kenya) National ID 102 - (Kenya) Alien ID 103 - Passport	FALSE
idNumber	string	ID number of administrator to be removed	FALSE

Response

00000

{
  "applicationId": ""
}