AML Screening with ID

A combined flow: it first verifies the ID (BVN, NIN, passport, …), then automatically screens the verified identity against sanction and PEP lists — one API call, one wallet transaction.

Try it

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

Request body

Body parameters

Field	Type	Description
`channel`required	string	ID verification channel (e.g. bvn, nin, cac). Get supported codes from GET /v3/screening/channels.
`number`required	string	The identity number to verify.
`checks`	array	AML checks to perform. Defaults to ["sanction","pep"].
`adverse_media`	boolean	Also perform an adverse-media search.
`compare`	boolean	Enable name comparison (requires first_name + last_name).

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": {
    "status": "FOUND",
    "identity": {
      "first_name": "BABATUNDE",
      "last_name": "RAYMOND"
    },
    "aml": {
      "hits": []
    }
  },
  "provider": "Farmsky Verify"
}

400 · Bad request

{
  "error": "invalid_request",
  "message": "channel and number are 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).