Register / Login Candidate with test link

Register / Login Candidate with test link

POSTRegister / Login Candidate with test link

This API will be used to register or log in a candidate. Additionally, this API is used to assign another course to a registered candidate.

Name and email address are required fields.

Pass ak, sgn, and ts as headers, and all three parameters will be received using the Signature Generation API.

Header
ak:{{API Key}}
sgn:{{sgn}}
ts:{{ts}}

URL
Copy
{{API Endpoint}}/api/v1/unifiedAuth

Body
Copy
{
  "name": "{Candidate Name}",
  "enrollment_number": "{Candidate Enrollment Number}",
  "email": "{Candidate Email}",
  "password": "{Candidate Password}",
  "mobile": "{Candidate Mobile No.}",
  "gender": "{Candidate Gender}",
  "dob": "{Candidate DOB}",
  "courseName": "{Candidate Course Name}",
  "profilePic": "{Candidate Profile Pic}"
}
Response
Case 1 : When Registration Success
Success
{
    "result": "success",
    "success": {
        "msg": "Registration Successfull."
    },
    "data": {
        "studentId": 85638625,
        "enrollmentNo": "GW228_1",
        "profilePic": "https://gw-thinksaasmerged-deploy.s3-ap-south-1.amazonaws.com/student/assets6/image/profile.png"
    },
    "laravelToken": "6yeY18koE6cB9ieTT70zK1xldgPAKev3mc7BvT5HN3OBdDVFfOK9L7uBllSdhckY+Ao9r7wh0DoOSu35*tGB9Q=="
}

Case 2 : When Login Success
Success
{
    "result": "success",
    "success": {
        "msg": "Login Successfull."
    },
    "data": {
        "studentId": 85638625,
        "enrollmentNo": "GW228_1",
        "profilePic": "https://gw-thinksaasmerged-deploy.s3-ap-south-1.amazonaws.com/55730/student/profile/85638625.jpeg"
    },
    "laravelToken": "6yeY18koE6cB9ieTT70zK4bXgAt31Z+ZX4VCoE6vss*gvKeTYkPxk+NoWbgXg8FwxZSR0wygmATuq3vr9dMQCA=="
}

Case 3 : When Details is missing
Error
{
    "result": "error",
    "error": {
        "code": "3023",
        "msg": "{field name} should not be blank"
    }
}

    • Related Articles

    • Candidate Login / Token Creation

      POSTCandidate Login / Token Creation This API will be used to log in a candidate. Request Parameters: email and password are required. The password is encoded in base64. Custom-Header{ "name": "{{Client URL}}" } URL Copy{{API ...

    • Register a Canddiate

      POSTRegister a Candidate This API will be used to register candidates. Request Parameters: The name, email, and password are required. The password is encoded in base64. Custom-Header{ "name": "{{Client URL}}" } URL Copy{{API ...

    • Assign Test to Candidate

      POSTAssign Test to Candidate This API will be used to assign tests directly to the candidates. Pass ak, sgn, and ts as headers, and all three parameters will be received using the Signature Generation API. Headerak:{{API Key}} sgn:{{sgn}} ts:{{ts}} ...

    • De-Assign Test from Candidate

      POSTDe-Assign Test from Candidate This API will be used to de-assign tests from candidates. Pass ak, sgn, and ts as headers, and all three parameters will be received using the Signature Generation API. Headerak:{{API Key}} sgn:{{sgn}} ts:{{ts}} URL ...

    • Candidate List mapped with Test

      POSTCandidate List mapped with Test This API will be used to retrieve all candidates and their details for testing. Pass ak, sgn, and ts as headers, and all three parameters will be received using the Signature Generation API. Headerak:{{API Key}} ...