Confirm OTP

Send OTP

POST /common/sendOtp

<This endpoint allows end users to send/resend OTP to its mobile or email>

Parameters

Parameters	Type	Description	Is Required
businessId	string	OnboardingID or Transaction Request ID	TRUE
otpType	string	SMS EMAIL	TRUE

Response

00000

{
  "code": "00000",
  "msg": "Completed successfully"
}

Confirm OTP

POST /common/confirmOperation

<This endpoint allows end users to confirm the OTP code that they received from mobile or email>

Parameters

Parameters	Type	Description	Is Required
businessId	string	OnboardingID or Transaction Request ID	TRUE
otpCode	string	The received OTP code	TRUE

Response

00000

{
  "code": "00000",
  "msg": "Completed successfully"
}

Universal Resend OTP

This api will support OTP resend capability operations for onboarding, accounts and transaction operations. You can use this endpoint to request the system to retry sending of OTP

POST /common/resendOtp

Fields	Type	Description	Required?
businessId	String	Onboarding or Transaction Request ID	Mandatory
otpType	String	SMS or EMAIL	Mandatory

Response

00000

{
  "code": "00000",
  "msg": "Completed successfully"
}

Send OTP - SME Account Administrator

POST /common/sendAccAdminOtp

<This endpoint allows SME's account administrators to send/resend OTP to its mobile or email>

Parameters

Parameters	Type	Description	Is Required
businessId	string	The unique string generated by BaaS platform to identify the application	TRUE
otpType	string	SMS EMAIL	TRUE
accountId	string	The number of the account that is to make the transfer	TRUE
accManagerIdNumber	string	The ID number of the account administrator	TRUE
idType	string	The ID type of the account administrator. 101 - (Kenya) National ID 102 - (Kenya) Alien ID 103 - Passport	TRUE

Response

00000

{
  "code": "00000",
  "msg": "Completed successfully"
}

Group Applications

POST /common/groupApplications

<This endpoint allows end users to group a batch of single transaction requests so that they can approve them in one OTP>

Parameters

Parameters	Type	Description	Is Required
applicationIdList	array	Array of string	TRUE

Response

00000

{
  "applicationId": ""//The new application Id that can be used to confirm OTP
}