Face Scan

Upload a face image and scan it against fraud-bank records and multiple-ID matches. Sent as multipart/form-data with an image file part.

Try it

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

Image file

Select a face image (JPG/PNG). It is base64-encoded in your browser and sent as a multipart file part.

Options

Body parameters

Field	Type	Description
`image`required	file	Face image file to scan for fraud detection (multipart file part; base64/data-URL also accepted).
`check_fraud_bank`	boolean	Whether to check against fraud bank records.
`check_multiple_ids`	boolean	Whether to check if the face appears in multiple national IDs.
`similarity_threshold`	number	Similarity threshold for face matching (0.0 to 1.0).

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": {
    "scan_id": "FS-A1B2C3D4E5F6",
    "overall_risk_score": 8.5,
    "risk_level": "LOW",
    "fraud_detected": false,
    "multiple_id_analysis": {
      "is_suspicious": false,
      "total_matches": 1,
      "unique_id_numbers": 1,
      "fraud_probability": 0.05,
      "risk_level": "LOW"
    },
    "fraud_bank_match": {
      "is_in_fraud_bank": false,
      "total_reports": 0,
      "verified_fraud": false
    },
    "general_analysis": {
      "identity_confidence": 0.94,
      "identity_consistency": true
    },
    "image_quality_score": 0.92,
    "recommendations": [
      "✅ LOW RISK - Standard verification procedures apply"
    ]
  },
  "provider": "Farmsky Verify"
}

400 · Bad request

{
  "error": "invalid_request",
  "message": "Invalid request or poor image quality"
}

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