v1

latestOpenAPI 3.1.02026-07-24450175.9 KB

Email Ownership

This API sends an OTP to the email address to verify user ownership

post/email/otp

Request body

callbackURLstring required
localestring

Language and country codes: for example, "en_US" for English and United States.

recipientstring required

User's email address

senderNamestring

User's name

senderEmailstring

Address that sends the email

metadatastring json

Metadata to be sent to a webhook (callbackUrl)

Response

200

{"stackTrail":"paths:/email/otp:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "data": {
    "confirmationCode": "0301"
  },
  "metadata": {
    "user_defined": "id00000"
  }
}