Background Check

Create Custom Package

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

Create a custom background-check package.

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

country string required

ISO-3166 alpha-3 country code (e.g. NGA).

allow_candidate_payment boolean

Whether candidates can pay for their own checks.

API Request Examples

curl --request POST \
  --url https://credit.farmsky.africa/v3/background/packages \
  --header 'Authorization: Bearer {CLIENT_ID}:{CLIENT_SECRET}' \
  --header 'x-api-key: {API_KEY}' \
  --header 'Content-Type: application/json' \
  --data '{"country":"NGA","allow_candidate_payment":"true"}'

const res = await fetch('https://credit.farmsky.africa/v3/background/packages', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {CLIENT_ID}:{CLIENT_SECRET}',
    'x-api-key': '{API_KEY}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "country": "NGA",
    "allow_candidate_payment": "true"
  }),
});
const data = await res.json();
console.log(data);

import requests

url = "https://credit.farmsky.africa/v3/background/packages"
headers = {
    "Authorization": "Bearer {CLIENT_ID}:{CLIENT_SECRET}",
    "x-api-key": "{API_KEY}",
    "Content-Type": "application/json",
}
payload = {
    "country": "NGA",
    "allow_candidate_payment": "true"
}
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/packages",
  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([
  "country" => "NGA",
  "allow_candidate_payment" => "true"
]),
]);

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

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

HttpClient client = HttpClient.newHttpClient();
String payload = "{\"country\":\"NGA\",\"allow_candidate_payment\":\"true\"}";
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://credit.farmsky.africa/v3/background/packages"))
    .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(`{"country":"NGA","allow_candidate_payment":"true"}`)
	req, _ := http.NewRequest("POST", "https://credit.farmsky.africa/v3/background/packages", 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,
  "id": "pkg-cust-1",
  "message": "Request successful",
  "data": {
    "id": "pkg-cust-1",
    "country": "NGA"
  },
  "provider": "Farmsky Verify",
  "record_id": "rec_1f4c9a20b8d34e77"
}

{
  "error": "invalid_request",
  "message": "country is required"
}

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