imocha logo
Below V2 API documentation is being deprecated. For latest API docs, visit

Register Candidate by Test Link

  • Description

    Register candidate for test using specific test link
  • URL structure

    https://api.interviewmocha.com/v2/org/tests/{testId}/testlinks/{testLinkId}/register

  • Request Method

    POST

  • Request Data

    Request URL Parameters
    Parameter Description Default Data Type Is Mandatory
    testId Test Id associated with particular test None Int64 Yes
    testLinkId Unique Test Link Id None Int64 Yes
    Request Body Parameters
    Parameter Description Default Data Type Is Mandatory
    fullName Full name of candidate None String Yes
    emailId Email Id of candidate None String Yes
    callbackURL After completion of test callback object will be send on this URL None String No
    redirectURL After completion of test candidate will redirect to this URL None String No

  • Sample Code

    Example Curl request will look like this:

    curl -i -H "x-api-key:YOUR_API_KEY_HERE" -H "content-type:application/json;charset=utf-8" -X POST https://api.interviewmocha.com/v2/org/tests/144659/testlinks/5412/register -d '{"emailId":"testemail@interviewmocha.com","fullName":"Amit Mishra", "callbackURL":"http://yoursite.com/savecallbackpage", "redirectURL":"http://yoursite.com/thankyoupage"}'

    Sample Response: 
     {
    "statuscode": "200.1",
    "description": "The request has succeeded.",
    "result": {
            "testInvitationId": 289045,
            "testUrl": "https://test.interviewmocha.com/AuthenticateKey?id=4004f1b983",
            "testAccessTime": "Assessment link is valid from 23-Feb-2018 04:16 PM  to 
                            24-Feb-2018 04:16 PM in (India Standard Time)"
    }
}