Appearance
Schedule interviews wherever you already do. The Interview Link API lets any scheduling system add imper.ai candidate verification to an interview with a single call: send the meeting join link, get back a verification link, and give that link to the candidate instead. The candidate verifies their identity on it and is sent straight on to the meeting.
There is nothing to install and no calendar or ATS integration to set up. If your system can make an HTTPS request when an interview is booked, it can use this API.
How It Works
Your system books an interview and has a Google Meet, Zoom or Microsoft Teams join link.
It calls the Interview Link API with that link, plus whatever it knows about the interview and the candidate.
imper.ai answers with a verification link for the interview.
Your system gives the candidate the verification link wherever they would normally find the meeting link - the calendar invite, the confirmation email, the candidate portal.
When the candidate opens it, imper.ai verifies them and sends them on to the meeting. The result shows up on the Candidates page in the imper.ai Admin Panel, like any other interview.
The same meeting link always returns the same verification link. Resends are safe: call again as often as you like.
Getting Access
The API is enabled per organization. imper.ai issues you two values:
An API key, sent in the
X-API-KEYheader.Your organization ID, sent in the
X-Organization-IDheader.
Keys are issued to approved customers and vendors only. Ask your imper.ai representative or support@imper.ai for both values. A key can be rotated on request.
IMPORTANT
The API key is a secret. Keep it in your system's secret store, never in client-side code and never in anything the candidate receives. If a key is exposed, contact imper.ai and it will be rotated.
You also need the Hiring use case active on your imper.ai organization, and meeting links on a supported platform: Google Meet, Zoom or Microsoft Teams, over https.
Endpoint
POST https://api.imper.ai/external/v1/link-wrapperHeaders
| Header | Value |
|---|---|
X-API-KEY | The API key issued by imper.ai. |
X-Organization-ID | Your imper.ai organization ID. |
Content-Type | application/json |
Request Body
| Field | Required | Description |
|---|---|---|
meeting_url | Yes | The Google Meet, Zoom or Microsoft Teams join link. https only. |
interview | Yes | The interview behind the link. An object with the fields below. |
The interview object
| Field | Required | Description |
|---|---|---|
candidate_id | Yes | The candidate's Workday WID, or their readable Candidate_ID. Either form is accepted. |
application_id | Yes | The Workday WID of the candidate's job application this interview is for. The role it was opened for titles the verification page. |
interview_id | No | The interview's id in your ATS. Send it once you have it; with a start time it also marks a reschedule onto a new link. |
source_event_id | No | The id of the interviewer's calendar event, kept with the interview. |
organizer_email | No | The email of the account the interview invite is sent from. |
candidate_email | No | The candidate's email address. |
candidate_name | No | The candidate's name, shown on the verification page. |
start_time | No | When the interview starts, in ISO 8601 with a timezone, for example 2026-11-03T15:00:00Z or 2026-11-03T17:00:00+02:00. Whole epoch seconds are also accepted. Leave it out when the link serves several sessions. |
end_time | No | When the interview ends, in the same format. Must be after start_time. Leave it out when the link serves several sessions. |
Text fields are limited to 200 characters and ids to 256. A time without a timezone, or a bare date, is rejected.
Response
json
{
"wrapped_url": "https://acme.imper.ai/verify/interview/PKyGxQGd5eYd3f7ErUcAc3"
}| Field | Description |
|---|---|
wrapped_url | The verification link to give the candidate in place of the meeting link. |
Status Codes
| Status | Meaning |
|---|---|
200 | The link was wrapped. The body carries wrapped_url. |
403 | The API key or organization ID is wrong, the API is not enabled for the organization, the organization has no Hiring use case, or the organization is read-only. |
409 | This meeting link is already wrapped by a different organization. |
422 | The request is invalid: a missing interview, candidate_id or application_id, an unsupported, malformed or non-https meeting link, a time without a timezone, end_time before start_time, an unknown field, or a field over its length limit. The body names the field. |
5xx | imper.ai could not wrap the link. The same request can be sent again safely, so retry once; if it keeps failing, contact the imper.ai team at support@imper.ai with the time of the call and the meeting link. |
Examples
A single-session interview with everything known:
bash
curl -X POST https://api.imper.ai/external/v1/link-wrapper \
-H "X-API-KEY: $IMPER_API_KEY" \
-H "X-Organization-ID: $IMPER_ORGANIZATION_ID" \
-H "Content-Type: application/json" \
-d '{
"meeting_url": "https://meet.google.com/abc-defg-hij",
"interview": {
"candidate_id": "b6efd5ffb9a490098d21777cec2f0001",
"application_id": "6cae2d01d8819001b5ce63296dcb0000",
"interview_id": "INTERVIEW-7781",
"source_event_id": "evt_8f2c1a",
"organizer_email": "recruiting@acme.com",
"candidate_name": "Dana Levi",
"candidate_email": "dana.levi@example.com",
"start_time": "2026-11-03T15:00:00Z",
"end_time": "2026-11-03T15:45:00Z"
}
}'json
{
"wrapped_url": "https://acme.imper.ai/verify/interview/PKyGxQGd5eYd3f7ErUcAc3"
}The smallest call, for a link shared by several sessions, is the link with the candidate and the application and no times:
bash
curl -X POST https://api.imper.ai/external/v1/link-wrapper \
-H "X-API-KEY: $IMPER_API_KEY" \
-H "X-Organization-ID: $IMPER_ORGANIZATION_ID" \
-H "Content-Type: application/json" \
-d '{
"meeting_url": "https://zoom.us/j/55512345678",
"interview": {
"candidate_id": "b6efd5ffb9a490098d21777cec2f0001",
"application_id": "6cae2d01d8819001b5ce63296dcb0000"
}
}'Giving the Link to the Candidate
Put wrapped_url everywhere the candidate would otherwise see the meeting link. Interviewers keep the original meeting link; only the candidate goes through verification.
NOTE
The verification link belongs to the interview, not to a device or session. A candidate who opens it on a different device is verified there.
Frequently Asked Questions
What happens if I send the same interview twice?
You get the same wrapped_url back, and the interview's details are updated rather than recorded again. The meeting link is what identifies the interview.
I wrap the link before the interview exists in Workday. Is that a problem?
No. Send the link without interview_id, and send it again with the id once you have it. The record stays the same.
Can I change the start time after scheduling?
Yes. Send the same link again with the new start_time and end_time.
What if the meeting link changes on a reschedule?
Send the new link with the same interview_id and the new times, and give the candidate the new wrapped_url. The old link stops counting as the interview.
One interview has several sessions. How do I send it?
One call per meeting link. If one link serves several sessions, send it without times. If each session has its own link, send each link without times and with the same interview_id.
Does the candidate need an imper.ai account?
No. The candidate opens the link, is verified, and is sent on to the meeting.
How do I get an API key?
From imper.ai. Keys are issued to approved customers and vendors; contact your representative or support@imper.ai.