v1

latestOpenAPI 3.1.02026-08-0416027.2 KB

Send OTP

API for sending OTP Verification via SMS, Email, Voice or Whatsapp

post/verification/create

Request body

channelstring required

Voice, SMS, WhatsApp or Email

senderstring required

Specify the sender you want to use. This is important when using SMS OR Whatsapp Channel or we will select a default sender from your account. Eg: KUDA OR +234810000000

token_typestring required

numeric or alphanumeric

token_lengthinteger required

The length of the token you want to send to your customer. Minimum is 4

expiration_timeinteger required

How long you want to the to be active for in minutes. (E.g 10 means 10 minutes )

customer_email_addressstring

The email address of your customer. It's required if you're using Email Channel

customer_mobile_numberstring

The phone number of your customer. It must be in international format (E.g 2348012345678). It is required if you're using the SMS or Voice Channel

tokenstring

You can pass in your own token.

Response

200

codeinteger

{"stackTrail":"paths:/verification/create:post:responses:200:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

messagestring

statusstring

Example response

{
  "code": 200,
  "data": {
    "business_uid": "17a2ed26-07e1-4fc8-9fa6-58adb83940e2",
    "reference": "MN-OTP-b638c07d-bf0b-4174-bbef-432ecc082cd3",
    "channel": {
      "id": 1,
      "name": "sms",
      "is_active": true
    },
    "token": "Abcde",
    "status": "sent"
  },
  "message": "Success",
  "status": "success"
}