pcall GET "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4"const res = await call("GET", "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4");
const { data } = await res.json();res = call("GET", "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/mandates/{mandate_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/mandates/{mandate_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/mandates/{mandate_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/mandates/{mandate_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": {
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"job_id": "job-10452",
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"status": "preparing",
"flow_version": 1,
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"title": "Warehouse Associate (Forklift)",
"company_name": "Acme Logistics Pvt Ltd",
"location_type": "india",
"location": {
"city": "Chennai",
"state": "Tamil Nadu",
"pincode": "600001"
},
"countries": [],
"location_names": [
"Chennai, Tamil Nadu"
],
"experience": {
"min_years": 1,
"max_years": 5
},
"openings": 12,
"salary": {
"min": 18000,
"max": 24000,
"currency": "INR",
"period": "month"
},
"description": "Pick, pack and load orders in a busy warehouse. Forklift licence preferred.",
"shift": "Day shift",
"employment_type": "Full-time",
"owner": {
"external_user_id": "recruiter_1042",
"name": "Priya Nair"
},
"skills": [
{
"skill_id": "sk_36440",
"name": "Forklift Basic Operation",
"verify": true,
"status": "active"
},
{
"skill_id": "sk_38973",
"name": "Pallet Jack Safety Check",
"verify": true,
"status": "active"
},
{
"skill_id": "sk_38824",
"name": "Packing Station Setup",
"verify": true,
"status": "active"
},
{
"skill_id": "sk_2338",
"name": "Order Picking",
"verify": false,
"status": "active"
},
{
"skill_id": "sk_2452",
"name": "Loading And Unloading",
"verify": false,
"status": "active"
},
{
"skill_id": null,
"name": "Reach Truck Operation",
"verify": false,
"status": "pending"
}
],
"enrichment_questions": [
{
"key": "has_licence",
"type": "yes_no",
"text": "Do you hold a valid forklift licence?",
"knockout": "no",
"required": true
},
{
"key": "why_this_job",
"type": "voice",
"text": "Tell us in your own words why you want this job.",
"knockout": null,
"required": false
}
],
"interest_collection": {
"other_roles": [
"Forklift Operator",
"Store Keeper"
]
},
"warnings": [
"Pending skills are kept on the mandate but cannot be verified until resolved"
],
"is_external": true,
"created_at": "2026-10-09T10:16:12.456Z",
"updated_at": "2026-10-09T10:16:12.456Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Get a job mandate
Read the mandate. Repeat until status is ready (questions prepared) before expecting candidates to be contacted. location_type says where the job is: for india, location holds the place; for abroad, countries lists { code, name } and location is null. location_names is every place or country name as the playground shows it.
Scope: mandates:read or mandates:write
pcall GET "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4"const res = await call("GET", "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4");
const { data } = await res.json();res = call("GET", "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/mandates/{mandate_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/mandates/{mandate_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/mandates/{mandate_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/mandates/{mandate_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": {
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"job_id": "job-10452",
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"status": "preparing",
"flow_version": 1,
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"title": "Warehouse Associate (Forklift)",
"company_name": "Acme Logistics Pvt Ltd",
"location_type": "india",
"location": {
"city": "Chennai",
"state": "Tamil Nadu",
"pincode": "600001"
},
"countries": [],
"location_names": [
"Chennai, Tamil Nadu"
],
"experience": {
"min_years": 1,
"max_years": 5
},
"openings": 12,
"salary": {
"min": 18000,
"max": 24000,
"currency": "INR",
"period": "month"
},
"description": "Pick, pack and load orders in a busy warehouse. Forklift licence preferred.",
"shift": "Day shift",
"employment_type": "Full-time",
"owner": {
"external_user_id": "recruiter_1042",
"name": "Priya Nair"
},
"skills": [
{
"skill_id": "sk_36440",
"name": "Forklift Basic Operation",
"verify": true,
"status": "active"
},
{
"skill_id": "sk_38973",
"name": "Pallet Jack Safety Check",
"verify": true,
"status": "active"
},
{
"skill_id": "sk_38824",
"name": "Packing Station Setup",
"verify": true,
"status": "active"
},
{
"skill_id": "sk_2338",
"name": "Order Picking",
"verify": false,
"status": "active"
},
{
"skill_id": "sk_2452",
"name": "Loading And Unloading",
"verify": false,
"status": "active"
},
{
"skill_id": null,
"name": "Reach Truck Operation",
"verify": false,
"status": "pending"
}
],
"enrichment_questions": [
{
"key": "has_licence",
"type": "yes_no",
"text": "Do you hold a valid forklift licence?",
"knockout": "no",
"required": true
},
{
"key": "why_this_job",
"type": "voice",
"text": "Tell us in your own words why you want this job.",
"knockout": null,
"required": false
}
],
"interest_collection": {
"other_roles": [
"Forklift Operator",
"Store Keeper"
]
},
"warnings": [
"Pending skills are kept on the mandate but cannot be verified until resolved"
],
"is_external": true,
"created_at": "2026-10-09T10:16:12.456Z",
"updated_at": "2026-10-09T10:16:12.456Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Authorizations
Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.
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).
Path Parameters
Record's mandate id (JM_...): the mandate_id returned when you create the mandate
^JM_[A-Z0-9]{10,40}$
