Background Check

Create Candidate Request

POST https://credit.farmsky.africa/v3/background/candidates

Create a background-check request for one or more candidates.

identity:read

Headers

Authorization string required Defaults to Bearer {CLIENT_ID}:{CLIENT_SECRET}

Your API client id and secret, joined by a colon. Manage credentials in the Console.

x-api-key string optional Defaults to {API_KEY}

Alternative single-value secret key header (equivalent to X-Api-Secret). Never expose it in client-side code.

Content-Type string required Defaults to application/json

All request bodies are JSON unless the endpoint accepts multipart/form-data (file uploads).

Body Params

package string required

ID (UUID) of the package to use.

candidates array required

Array of candidate objects.

callback_url string

URL for the status callback webhook.

service_type string

self-service or proxy.

information_method string

Data collection method.

API Request Examples

curl --request POST \
  --url https://credit.farmsky.africa/v3/background/candidates \
  --header 'Authorization: Bearer {CLIENT_ID}:{CLIENT_SECRET}' \
  --header 'x-api-key: {API_KEY}' \
  --header 'Content-Type: application/json' \
  --data '{"package":"a1b2c3d4-0000-1111-2222-333344445555","service_type":"self-service","candidates":[{"candidate_email":"jane@example.com"}]}'

const res = await fetch('https://credit.farmsky.africa/v3/background/candidates', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {CLIENT_ID}:{CLIENT_SECRET}',
    'x-api-key': '{API_KEY}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "package": "a1b2c3d4-0000-1111-2222-333344445555",
    "service_type": "self-service",
    "candidates": [
      {
        "candidate_email": "jane@example.com"
      }
    ]
  }),
});
const data = await res.json();
console.log(data);

import requests

url = "https://credit.farmsky.africa/v3/background/candidates"
headers = {
    "Authorization": "Bearer {CLIENT_ID}:{CLIENT_SECRET}",
    "x-api-key": "{API_KEY}",
    "Content-Type": "application/json",
}
payload = {
    "package": "a1b2c3d4-0000-1111-2222-333344445555",
    "service_type": "self-service",
    "candidates": [
        {
            "candidate_email": "jane@example.com"
        }
    ]
}
resp = requests.post(url, headers=headers, json=payload)
print(resp.json())

<?php
$ch = curl_init();
curl_setopt_array($ch, [
  CURLOPT_URL => "https://credit.farmsky.africa/v3/background/candidates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {CLIENT_ID}:{CLIENT_SECRET}",
    "x-api-key: {API_KEY}",
    "Content-Type: application/json",
  ],
  CURLOPT_POSTFIELDS => json_encode([
  "package" => "a1b2c3d4-0000-1111-2222-333344445555",
  "service_type" => "self-service",
  "candidates" => [
    [
      "candidate_email" => "jane@example.com"
    ]
  ]
]),
]);

$response = curl_exec($ch);
curl_close($ch);
echo $response;

import java.net.URI;
import java.net.http.*;

HttpClient client = HttpClient.newHttpClient();
String payload = "{\"package\":\"a1b2c3d4-0000-1111-2222-333344445555\",\"service_type\":\"self-service\",\"candidates\":[{\"candidate_email\":\"jane@example.com\"}]}";
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://credit.farmsky.africa/v3/background/candidates"))
    .header("Authorization", "Bearer {CLIENT_ID}:{CLIENT_SECRET}")
    .header("x-api-key", "{API_KEY}")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(payload))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{"package":"a1b2c3d4-0000-1111-2222-333344445555","service_type":"self-service","candidates":[{"candidate_email":"jane@example.com"}]}`)
	req, _ := http.NewRequest("POST", "https://credit.farmsky.africa/v3/background/candidates", payload)
	req.Header.Add("Authorization", "Bearer {CLIENT_ID}:{CLIENT_SECRET}")
	req.Header.Add("x-api-key", "{API_KEY}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

RESPONSE

{
  "request_id": "req_8f2c1a9b7d3e4f60",
  "live": true,
  "ok": true,
  "response_code": "00",
  "status": "VERIFIED",
  "found": true,
  "soft_error": false,
  "async_pending": false,
  "reference": "CAND-REF-9",
  "message": "Request successful",
  "data": {
    "reference": "CAND-REF-9",
    "status": "pending"
  },
  "provider": "Farmsky Verify",
  "record_id": "rec_1f4c9a20b8d34e77"
}

{
  "error": "invalid_request",
  "message": "package (package UUID) is required"
}

{
  "error": "unauthorized",
  "message": "API credentials required. Send Authorization: Bearer <client_id>:<secret>."
}