Document Verification

Verify an identity document and optionally match it to a selfie.

Try it

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

Request body

Body parameters

Field	Type	Description
`doc_image`required	string	Base64-encoded document image (< 1 MB).
`doc_type`	string	Document type (PASSPORT \| NATIONAL_ID \| DRIVERS_LICENSE).
`doc_country`	string	ISO-3166 alpha-2 country of issue.
`selfie_image`	string	Optional base64 selfie — enables face-match / liveness.

Example responses

200 · Result

{
  "request_id": "req_8f2c1a9b7d3e4f60",
  "ok": true,
  "status": "VERIFIED",
  "found": true,
  "face_match": true,
  "data": {
    "doc_type": "NATIONAL_ID",
    "name": "JANE WANJIKU",
    "match_confidence": 0.97
  },
  "provider": "Farmsky Verify"
}

400 · Bad request

{
  "error": "invalid_request",
  "message": "doc_image (base64) 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).