Docs home

Learner Exist or Not on Platform Validation

Checks whether a login ID (email, mobile number or username) already has an account in your institute. Use it on your website's signup or login form to decide whether to show "sign up" or "log in", and whether to ask for a second factor.

GET/user/checkifexists
Learner Exist or Not on Platform Validation
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/user/checkifexists?institution_id=<institutionId>&contact_number_country_id=103&calling_modal=signup'
{
  "code": 200,
  "message": "Success",
  "payload": {
    "multiple_account_exists": 0,
    "is_user_exists": 1,
    "is_user_mfa_enabled": 0
  }
}

Access: Public, no API key needed.

Query parameters
userstringrequired
Email, mobile number or username. English letters, digits and @ . + - _ only.
Institute to check. Defaults to the institute of the host you call.
Where you call from: login, signup or default (default). With signup and a numeric user, the number is validated as a mobile number. With login, when the institute has multi-factor authentication on, only email and mobile number are matched (not username).
Country of the mobile number (country_code_id from "Countries List"). Used with calling_modal=signup. If left out, it is guessed from the caller's IP, falling back to India.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
payloadobject
Show child attributesHide child attributes
1 if more than one account matches
Example: 0
1/0
Example: 1
1 if this user must complete multi-factor authentication at login
Example: 0

Notes: Errors: "Only English letters, digits, @, ., +, , -, and _ are allowed..." for other characters, and "Please enter a valid mobile number." for an invalid number at signup.

Updated yesterday

Ask AI