v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB

z) Global Functionality

Send an OTP to a customer

Sends an OTP via SMS or email to the supplied phone number, email address, or identity. Accepts phone numbers in any common format. No JWT is required, but a Google reCAPTCHA token must be provided in the request header.

post/eclipse-conductor/rest/v1/global/verifications

Request body

emailstring

Customer email number where the email link will be sent

identitystring

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.

phonestring

Customer phone number where the OTP will be sent

templateIdstring

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.

tenantIdinteger

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

type'EMAIL' | 'PUSH' | 'SMS' | 'TEMPLATE'

Response

No Content