Create Candidate Request

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

Try it

Sandbox returns deterministic mock data, no wallet charge. Checking Live availability…

Request body

Body parameters

Field	Type	Description
`package`required	string	ID (UUID) of the package to use.
`candidates`required	array	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.

Example responses

200 · Created

{
  "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"
}

400 · Bad request

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

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).