API Reference

This API can be used for whole authentication flow for any kind of application.
Use Cases:

  1. To generate OTP : We will send an OTP to the provided email and the same will be provided in API response.
  2. To register User : We will store the user data which is provided in request body. (Email field is required)
  3. To login User : We will verify the user data and send a jwt token if verification is successful.
    Note : OTP generation is rate limited API. (1 request/min)
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Credential id given by the platform

Query Params
string
required

This query determines what the API should do.

Body Params

Request body. The required properties and their types depend on the type query parameter:

  • type=otp: Required properties: email (string).
  • type=register: Required properties: email (string), otp (string). Additional properties are allowed.
  • type=login: Required properties: email (string), otp (string).
string
required
Responses

400

Invalid status value

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json