Send a one-time code to a customer
Sends a 6-digit code to the customer’s email or phone (send one). Limited to 5 codes per email or phone per hour; a code expires after 10 minutes. Customers without a KetaPay account can verify too: their account is created when the code is verified.
Authorizations
Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown
once when created in the dashboard, and are scoped (see x-required-scope on each
operation). Keep them on your server. Live keys are issued after your business is
verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.
Headers
Unique key for this operation. Retries with the same key return the first result.
255"7f3e2a10-6c4d-4b8e-9a1f-2d5c8e7b6a40"
Body
Response
Code sent
"customer_session"Email address. Matched without regard to case.
254"ada@example.com"
Nigerian mobile number in E.164 format
^\+234[789][01]\d{8}$"+2348012345678"
code_sent, verified, failed, expired Where the code was delivered
email, whatsapp, sms When the code stops working