/v3/fraud/identity-risk
identity:read
Identity Risk Scan
Composite fraud / identity-risk scan from a flexible payload.
Try it
Sandbox returns deterministic mock data, no wallet charge. Checking Live availability…
Request body
Body parameters
| Field | Type | Description |
|---|---|---|
national_id |
string | Identity number to risk-scan. |
phone_number |
string | Phone number to include in the scan. |
email |
string | Email address to include in the scan. |
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": {
"risk_score": 12,
"risk_band": "LOW",
"signals": []
},
"provider": "Farmsky Verify"
}
400 · Bad request
{
"error": "invalid_request",
"message": "a fraud-check payload 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).