Docs home

Signup OTP Send for Email

Emails a 6-digit one-time code to a new learner who wants to sign up with their email address. This is step 1 of OTP signup; step 2 is "Verify OTP for Email", step 3 is "Signup User".

POST/email/signup/otp
Signup OTP Send for Email
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/email/signup/otp' \
  --form 'JSONString={"institution_id":1613,"email":"hemal+signup@edmingle.com"}'
{
  "code": 200,
  "message": "Success"
}

Access: Public, no API key needed.

Request body: form-data with one field, JSONString, containing this JSON:

BodyJSONString
emailstringrequired
Email address to send the code to.
Your institution ID. Defaults to the institute of the website host you call.
Response200application/json
codeinteger
Example: 200
messagestring
"Success"
Example: Success

Notes: The code is valid for 30 minutes; requesting a new one cancels earlier unexpired codes for that email. Fails with "Email already registered. Please login if you have an account" if a user with that email already exists in the institute. The email uses your institute's branding and notification templates. Signup must be allowed on the calling platform. Rate limit: 10 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI