Docs home

Signup User

Creates a learner account in your institute and logs them in, returning an API key. If OTP signup is enabled for your institute, web sign-ups must first verify their email or mobile number and pass the token from "Verify OTP for Email" / "Verify OTP for Contact Number".

POST/user/signup
Signup User
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/user/signup' \
  --form 'JSONString={
  "contact_number": "7898898189",
  "contact_number_country_id": "103",
  "name": "SampleUser",
  "email": "",
  "password": "test",
  "role":1,
  "institute_id": <institutionId>,
  "signup_verify_token": "7facacaae6b40423b84343a00ee4ef6d9c34229f3ce7a6983de19f419dd3e451"
}'
{
  "user": {
    "apikey": "9e845d82a5c1ea0906ae2e388bbce951",
    "username": "SampleUser1216912",
    "user_id": 168687,
    "role": "student",
    "server_key": "e76f3adfe3405e8dbab478c168ee5cc8",
    "is_sign_up": 1,
    "contact_number": "7898898189",
    "email": "",
    "redirectURl": "https://<YourCustomDomain>.edmingle.com"
  },
  "message": "Success",
  "code": 200
}

Access: Public, no API key needed. Only learner accounts can be created this way.

Request body: form-data with one field, JSONString, containing this JSON. Files for file-type custom fields go as separate file fields (PDF, up to 1 MB).

BodyJSONString
roleintegerrequired
Must be 1 (learner), sent as a number. Anything else fails with "Operation not authorized".
passwordstringrequired
Up to 20 characters.
namestring
Full name. Letters, spaces, apostrophes and dots only.
emailstringOne of email or contact_number
Email address. Must not be taken ("Email already Taken").
contact_numberstringOne of email or contact_number
Mobile number.
Country of the mobile number. Defaults from the caller's location.
signup_verify_tokenstringWhen OTP signup is on
Token from the verify-OTP call. Its email or number must match the one sent here.
Your institution ID. Must match the institute of the website host, otherwise "Unauthorized action.".
Batch join code; the learner is added to that batch.
bundle_idinteger
Course to enroll the learner in right after signup (starts the purchase; payment details come back in the response).
Another learner's referral code. Invalid codes fail with "Invalid Referral Code".
Answers to your institute's learner signup fields (see "Get Signup Custom Fields").
Your own ID for this learner.
App device details for push notifications.
Response200application/json
userobject
Show child attributesHide child attributes
Use it as APIKEY for this learner
Example: 9e845d82a5c1ea0906ae2e388bbce951
Generated
Example: SampleUser1216912
Example: 168687
user.rolestring
student
Example: student
Example: e76f3adfe3405e8dbab478c168ee5cc8
Example: 1
Example: 7898898189
Your learner portal URL
Example: https://<YourCustomDomain>.edmingle.com
messagestring
Example: Success
codeinteger
Example: 200

Notes: The learner joins your online organization, or the organization of the custom domain you call. A signup email is sent. Errors: "OTP verification required before signup.", "Signup session expired or invalid. Please verify OTP again.", "Primary field mismatch. Please verify OTP again.", "Please enter a valid mobile number.", "Invalid Params" (a website address in the name). Rate limit: 10 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI