Who am I

This endpoint allows candidates to aquire informations regarding his interview.

To read this endpoint, the candidate is required to use either a Token or his Activation Key.

Activation Key

The activation key can be obtained by the candidate from his email.

In his invitation email, he will have a link like:

https://your-company.interview-suite.com/cfev3/register/<32-characters-long-activation-key>

The last fragment of the URL is his activation key, and can be used to read his own data.

Object

/whoami/candidate/

Methods

GET

Example response

curl -H 'Authorization: ActivationKey abcdef1234567890987654321fedcbab' https://your-company.interview-suite.com/api/v3/whoami/candidate/
{
  "resource_uri": "https://your-company.interview-suite.com/api/v3/companies/1/projects/13/candidates/62/",
  "photo": "",
  "first_name": "Rafael",
  "last_name": "Goncales",
  "gender": "mr",
  "email": "rafael.goncales@somewhere.xom",
  "status": "confirmed",
  "invitationdate": "2016-11-01T09:44:56Z",
  "confirmationdate": "2016-11-08T14:44:03Z",
  "interviewdate": null,
  "deadline": "2016-11-08T22:59:00Z",
  "activation_key": "abcdef1234567890987654321fedcbab",
  "seconds_until_deadline": 221670,
  "company": {
    "resource_uri": "https://your-company.interview-suite.com/api/v3/companies/1/",
    "name": "Your Company",
    "division": "",
    "address": "Some address",
    "postcode": "123456",
    "city": "Some city",
    "state_province": "",
    "country": "https://your-company.interview-suite.com/api/v3/countries/1/",
    "phone": "+49 123 4567890",
    "design_settings": "https://your-company.interview-suite.com/api/v3/companies/1/design/"
  },
  "project": {
    "name": "Position title",
    "videos": [],
    "questions": "https://your-company.interview-suite.com/api/v3/companies/1/projects/13/questions/",
    "resource_uri": "https://your-company.interview-suite.com/api/v3/companies/1/projects/13/",
    "support_lang": "en",
    "language": "en-GB"
  },
  "contact_person": {
    "resource_uri": "https://your-company.interview-suite.com/api/v3/companies/1/customers/1/",
    "gender": "mrs",
    "first_name": "Helen",
    "last_name": "Millër",
    "email": "dev@viasto.com",
    "phone": "07111 11 11 10",
    "photo": "https://your-company.interview-suite.com/api/v3/companies/1/customers/1/photo/IjQ1NzA4NzJlNjUzODU5ZjU1ZDZmY2NiMDM2ZjIzNTkxNTki.CdMG.VeK0lH9_7EP6ec/",
    "position": ""
  }
}

As you can see, some of the information can only be found following the reference link, but all of them requires the candidate to use a valid token aquired only when using the proper authentication endpoint.