/v3/background/candidates/:reference
identity:read
Get Candidate Request Detail
Retrieve a single candidate request by its reference.
This endpoint has a path parameter. Call it from your own client using the reference below.
Path parameters
| Field | Type | Description |
|---|---|---|
referencerequired |
string | Candidate request reference from Create/List. |
Example responses
200 · Result
{
"request_id": "req_8f2c1a9b7d3e4f60",
"live": true,
"ok": true,
"response_code": "00",
"status": "VERIFIED",
"found": true,
"soft_error": false,
"async_pending": false,
"reference": "VR-D4ACE26C68A3",
"message": "Verification successful.",
"data": {
"reference": "CAND-REF-9",
"status": "in_progress",
"checks": []
},
"provider": "Farmsky Verify"
}
401 · Unauthorized
{
"error": "unauthorized",
"message": "API credentials required. Send Authorization: Bearer <client_id>:<secret>."
}
Runs use your signed-in session. For system-to-system integration, issue a keypair in the
Console and send
Authorization: Bearer <client_id>:<secret> against
https://credit.farmsky.africa (Sandbox https://sandbox.credit.farmsky.africa).