cURL
pcall GET "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates/6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33"const res = await call("GET", "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates/6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33");
const { data } = await res.json();res = call("GET", "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates/6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/candidates/{candidate_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-secret-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/candidates/{candidate_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/candidates/{candidate_id}")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/candidates/{candidate_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"candidate_id": "6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33",
"external_id": "cand-1001",
"name": "Ravi Kumar",
"phone_number": "+919876543210",
"status": "completed",
"language": "english",
"campaign_id": "EC_261121095438377TFUX07WN2XT42V",
"is_interested": true,
"is_completed": true,
"completed_channel": "whatsapp",
"completed_at": "2026-11-10T11:02:10.000Z",
"first_engagement_channel": "whatsapp",
"delivery_error": null,
"journey": {
"invite_sent_at": "2026-11-10T10:31:00.000Z",
"follow_ups": 0,
"sms_sent_at": null,
"call_attempts": 0,
"call_answered_at": null,
"link_opened_at": "2026-11-10T10:58:00.000Z",
"opted_out_at": null
},
"answers": [
{
"question_id": "eqq_cc9800817588972e",
"order": 0,
"question_text": "Are you open to a new job right now?",
"type": "yes_no",
"required": true,
"answered": true,
"text": [
"Yes"
],
"channel": "whatsapp",
"transcript_english": null,
"audio_url": null,
"qualified": true
},
{
"question_id": "eqq_7a31f0c2d95b84e6",
"order": 1,
"question_text": "Tell us about the work you do and where you want to work.",
"type": "voice",
"required": true,
"answered": true,
"text": [
"Forklift operator, 4 years, Chennai"
],
"channel": "web",
"transcript_english": "I drive a forklift, four years, in Chennai",
"audio_url": null,
"qualified": null
}
],
"result": {
"result_id": "ERS_261121100210123X5T9K2M7Q4R8WV",
"status": "completed",
"completed_channel": "whatsapp",
"completed_at": "2026-11-10T11:02:10.000Z",
"summary": {
"answered_count": 2,
"required_count": 2,
"qualified_count": 1
}
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Candidates
Get a candidate
One candidate in full: what was sent and when, every answer, and the result once they finish. The English transcript of a spoken answer is translated the first time it is read, so that read can be slower.
Scope: enrichment:read or enrichment:write or enrichment:campaigns
GET
/
enrichments
/
{enrichment_id}
/
candidates
/
{candidate_id}
cURL
pcall GET "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates/6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33"const res = await call("GET", "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates/6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33");
const { data } = await res.json();res = call("GET", "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates/6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/candidates/{candidate_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-secret-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/candidates/{candidate_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/candidates/{candidate_id}")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/candidates/{candidate_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"candidate_id": "6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33",
"external_id": "cand-1001",
"name": "Ravi Kumar",
"phone_number": "+919876543210",
"status": "completed",
"language": "english",
"campaign_id": "EC_261121095438377TFUX07WN2XT42V",
"is_interested": true,
"is_completed": true,
"completed_channel": "whatsapp",
"completed_at": "2026-11-10T11:02:10.000Z",
"first_engagement_channel": "whatsapp",
"delivery_error": null,
"journey": {
"invite_sent_at": "2026-11-10T10:31:00.000Z",
"follow_ups": 0,
"sms_sent_at": null,
"call_attempts": 0,
"call_answered_at": null,
"link_opened_at": "2026-11-10T10:58:00.000Z",
"opted_out_at": null
},
"answers": [
{
"question_id": "eqq_cc9800817588972e",
"order": 0,
"question_text": "Are you open to a new job right now?",
"type": "yes_no",
"required": true,
"answered": true,
"text": [
"Yes"
],
"channel": "whatsapp",
"transcript_english": null,
"audio_url": null,
"qualified": true
},
{
"question_id": "eqq_7a31f0c2d95b84e6",
"order": 1,
"question_text": "Tell us about the work you do and where you want to work.",
"type": "voice",
"required": true,
"answered": true,
"text": [
"Forklift operator, 4 years, Chennai"
],
"channel": "web",
"transcript_english": "I drive a forklift, four years, in Chennai",
"audio_url": null,
"qualified": null
}
],
"result": {
"result_id": "ERS_261121100210123X5T9K2M7Q4R8WV",
"status": "completed",
"completed_channel": "whatsapp",
"completed_at": "2026-11-10T11:02:10.000Z",
"summary": {
"answered_count": 2,
"required_count": 2,
"qualified_count": 1
}
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Authorizations
Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).

