Query Parameter | Description |
| ak | This is your Public-API-Key, which Mettl uses to identify your account. |
| ts | This is the current UNIX or Epoch Timestamp (the number of seconds between 1970-01-01 00:00:00 and current UTC Time). Any current generated Timestamp will be valid for 24 hours only. |
| asgn | This is a unique Signature which has to be generated for each API request . The Signature is generated by creating a String-to-Sign and hashing it with your Private-API-Key using the HMAC-SHA256 (for version v2 and v3) or HMAC-SHA1 (for v1) hashing algorithm with Base-64 and URL encoding. Read more about the above Signature Generation Process in API Authentication and Signature Generation. |
| rd | This is a JSON string containing the details of the candidates for generating candidate specific test links. You can send the details of up to 20 candidates at once. The format for the JSON is given below |
Query Parameter | Description |
| allowMissingMandatoryRegistrationFields | Allows you to skip the mandatory fields while registering a candidate. The candidate has to fill the remaining mandatory fields to start the test. The mandatory Fields “Email Address”, “First Name” cannot be skipped using this parameter. You can input either true or false, with the default value being false. |
| timeLimitInSec | Allows generating links that expire after the specified time limit in seconds. You can input a value greater than 0, with the default functionality resulting in test links that don't expire. |
showCustomInstructions | Allows you to show custom instructions that been set in the assessment, to be displayed to the candidate before the assessment starts. You can input either true or false, with the default value being false. |
| Property | Sub Property | Description |
| registrationDetails | Registration Details of the candidate for which you want to generate an encrypted test link. This list of nested JSON(s) is mandatory and accepts details of up to 20 candidates at a time. eg. [{"First Name": "Name", "Email Address": "name@email.com", "Date of birth": "Sep 16 1998"},{"First Name": "Name2", "Email Address": "name2@email.com", "Date of birth": "Jan 1 1996"}] | |
| ↳ | Email Address | Candidate's email Id. This string is mandatory and has to be unique for each candidate in a schedule/ test link. |
| ↳ | First Name | Candidate's name. This string is mandatory |
| ↳ | *exact name of other Candidate Registration Fields | This property represents all other candidate registration fields and the name of the property is the exact name of the registration field. This string is mandatory depending on the mandatory registration fields configured in an assessment or account but can be skipped using allowMissingMandatoryRegistrationFields . |
| optionalParams | Metadata of the candidate for which you want to generate an encrypted test link. This list of nested JSON(s) is optional and accepts details of up to 20 candidates at a time. | |
| ↳ | Candidate's email Id to which you want to add context metadata. This string is optional and only accepts email Ids which is part of the registrationDetails above. | |
| ↳ | context_data | Metadata of candidates who are being registered. This metadata would then be passed back in Webhook notifications and on demand results. This string is optional |