talentsee

TalentSee API

TalentSee’s API gives you the power to integrate video interviewing into your applications and processes. The API gives you access and control to the entire interview lifecycle and process in a secure, intuitive and simple way, using our versatile API.

Whether you want to integrate the video inviting capability into your ATS or you simply want to host the interview results in your own back office tooling, then our API provides you with all the tooling you require.

If you are looking to use video questioning for alternate uses other than recruitment, then the API should provide you with all of the capability you need to create your own custom technologies.

The REST API can only be connected using SSL on https://api.talentsee.com/ and returns standard HTTP code responses.

Authentication

Description

TalentSee uses OAuth (https://en.wikipedia.org/wiki/OAuth) an open standard for authorisation used in many of the internet’s largest and most influential websites.

TalentSee’s implementation of OAuth requires only your Subscription Key (this can be obtained by contacting support@talentsee.com) in order to authenticate.

Url POST

https://api.talentsee.com/token

Curl

curl -d "grant_type=password&password=cda2a7d95a1d4a93aa3141124c02550b" -H "Content-Type: application/json" -X POST https://api.talentsee.com/token

Response

{  
    'access_token': '{AccessToken}',
    'token_type': 'bearer',
    'expires_in': '{ExpiryUTC}'
}
                

You will then need to use the access token to each subsequent request i.e.

curl -H "Content-Type: application/json" -X GET https://api.talentsee.com/api/v2/candidates/embedvideo/ --header "Authorization: Bearer {AccessToken}"

Show less

Create Candidates

Description

Will create a new candidate and return a unique identifier for that candidate. A candidate’s email address must be unique to that subscription.

Url POST

https://api.talentsee.com/v2/candidates

Sample

{
	'FirstName': '{FirstName}',
	'LastName': '{LastName}',
	'EmailAddress': '{EmailAddress}',
	'ExternalId': '{ExternalId}'
}

Parameters

FirstName

Candidate’s first name

String

LastName

Candidate’s last name

String

EmailAddress

Candidate’s Email Address

String

ExternalId

The integrators identifier, this can be used to identify the candidate in subsequent calls.

String

Response

{
  'Id': '{CandidateId}',
  'WasSuccessful': true,
  'ErrorMessages': [],
  'SuccessMessage': null
}
                

Curl

curl https://api.talentsee.com/api/v2/candidates -H "Content-Type: application/json" -X POST --header "Authorization: Bearer {AccessToken}" -d "{'FirstName': 'Example', 'LastName': 'Candidate', 'EmailAddress': 'example.candidate@email.com', 'ExternalId': 'YourIdentity'}"
Show less

Invite

Description

Creates an interview invite

Url POST

    https://api.talentsee.com/v2/candidates/invite/{notify:bool}

Sample

{
	'InterviewId': '{InterviewId}',
	'ExpiryDate': '{ExpiryDate}',
	'CandidateId': '{CandidateId}',
	'CandidateExternalId': '{CandidateExternalId}'
}

Parameters

InterviewId

The Id of the interview you wish to invite the candidate to.

Guid

ExpiryDate

The expiry date of the invite. The system will not allow candidate’s to take the interview after this date.

DateTime (nullable)

CandidateId

TalentSee’s id for candidate’s.

Guid (nullable)

CandidateExternalId

The integrators id for the candidate.

Guid (nullable)

Curl

curl https://api.talentsee.com/api/v2/candidates -H "Content-Type: application/json" -X POST --header "Authorization: Bearer {AccessToken}" -d "{'InterviewId': 'f6ae59e5-88d5-4198-9617-a143a2277017', 'ExpiryDate': '2016-07-01T12:00:00.000Z', 'CandidateId': '206432fc-65d1-4777-8576-99a477dbf173', 'CandidateExternalId': 'YourIdentity'}"
Show less

Reset Interview

Description

Resets the interview invite, so that the candidate can begin it again.

Url POST

https://api.talentsee.com/v2/candidates/resetinterview

Sample

{
	'InterviewId': '{InterviewId}',
	'CandidateId': '{CandidateId}',
	'CandidateExternalId': '{CandidateExternalId}'
}

Parameters

InterviewId

The Id of the interview you wish to invite the candidate to.

Guid

CandidateId

TalentSee’s id for candidate’s.

Guid (nullable)

CandidateExternalId

The integrators id for the candidate.

Guid (nullable)

Curl

curl https://api.talentsee.com/api/v2/candidates -H "Content-Type: application/json" -X POST --header "Authorization: Bearer {AccessToken}" -d "{'InterviewId': 'f6ae59e5-88d5-4198-9617-a143a2277017', 'CandidateId': '206432fc-65d1-4777-8576-99a477dbf173', 'CandidateExternalId': 'YourIdentity'}"
Show less

Change Expiry Date

Description

Supports changing the expiry date of an existing invite.

Url POST

https://api.talentsee.com/v2/candidates/changeexpirydate

Sample

{
	'InterviewId': '{InterviewId}',
	'ExpiryDate': '{ExpiryDate}',
	'CandidateId': '{CandidateId}',
	'CandidateExternalId': '{CandidateExternalId}'
}

Parameters

InterviewId

The Id of the interview you wish to invite the candidate to.

Guid

ExpiryDate

The expiry date of the invite. The system will not allow candidate’s to take the interview after this date.

DateTime (nullable)

CandidateId

TalentSee’s id for candidate’s.

Guid (nullable)

CandidateExternalId

The integrators id for the candidate.

Guid (nullable)

Curl

curl https://api.talentsee.com/api/v2/changeexpirydate -H "Content-Type: application/json" -X POST --header "Authorization: Bearer {AccessToken}" -d "{'InterviewId': 'f6ae59e5-88d5-4198-9617-a143a2277017', 'ExpiryDate': '2016-07-01T12:00:00.000Z', 'CandidateId': '206432fc-65d1-4777-8576-99a477dbf173', 'CandidateExternalId': 'YourIdentity'}"
Show less

Web Hooks

Description

A Web Hook event is fired every time the candidate/interview goes through a new step. To arrange call backs, please contact the support team (support@talentsee.com) with the web hook end point to call back to.

The Web Hook will send the following JSON

{  
   'SourceType": '{SourceType}',
   'InterviewId": '{InterviewId}',
   'CandidateId": '{CandidateId}',
   'CandidateExternalId': '{CandidateExternalId}'
}

Source Types

CandidateFinishedInterview

Fired when a candidate finishes an interview.

Fired when a candidate finishes an interview.

Show less

Embed Video

Description

You can embed our HTML5 video player for any results in your web page. There are no additional references, Javascript or CSS necessary, simply call the REST method and embed the returned content.

Url GET

https://api.talentsee.com/v2/embedvideo/{interviewId:Guid}/{candidateId:Guid}/{questionId:Guid}

Parameters

InterviewId

The Id of the interview you wish to invite the candidate to.

Guid

CandidateId

TalentSee’s id for candidate’s.

Guid

QuestionId

The interview question id.

Guid

Response JSON

{
	'PlayerHtml': '<video id="html5-video-id" src="{1}"
                         controls="controls"
                         preload="auto"
                         autoplay />'
}                    

Example Player

Curl

curl https://api.talentsee.com/api/v2/candidates -H "Content-Type: application/json" -X POST --header "Authorization: Bearer {AccessToken}" -d "{'FirstName': 'Example', 'LastName': 'Candidate', 'EmailAddress': 'example.candidate@email.com', 'ExternalId': 'YourIdentity'}"
Show less
talentsee

Our range of resources are designed to make your experience as positive as possible ensuring that you perform the best that you can.