API

Send an OTP sms/email to a customer

post
https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/global/verifications

The method takes the cell phone number, email or identity to send the OTP to. Backend will do its best to accept any format of phone number e.g. 083... 2783... etc. This API does not need a JWT to be used but it required google recaptcha verification code(gCaptcha) in a request header.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Customer email number where the email link will be sent

string

Customer identity where the OTP will be sent. Eclipse will look up the customers phone number or email based on the identity passed to send otp.

string

Customer phone number where the OTP will be sent

string

Mustache template Id for verification. The eclipse will look templateId in the property if templateId is found then it will send Email else return an error.

int64

Optional. The tenants id if known so that tenant specific messaging can be done

string
enum

Verification type. Defaults to SMS if not provided

Allowed:
Responses
201

Created

400

Bad Request

Updated 7 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 7 months ago