Account Administrator

Add Account Administrator for SME

POST /account/v2/addAccountAdministrator

<Use this endpoint to add account administrator for SME customers>

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

{
  "accAdminRequestId": ""
}

Verify Account Administrator

POST /account/verifyAccountAdministrator

<Use this endpoint to verify account administrator's mobile or email address. Only after verifying, the account administrator is ready to make transfers because making transfer requires OTP confirmation via its phone or email.>

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

{
  "applicationId": ""
}

Remove Account Administrator

POST /account/removeAccountAdministrator

<Use this endpoint to remove an account administrator from an account then that account administrator will no longer have access to make any operations on that account. >

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

countryCode

string

country code of that account administrator's mobile

FALSE

mobile

string

Mobile number the account administrator that is 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 the administrator that is to be removed.

FALSE

Response

{
  "applicationId": ""
}

Last updated