Skip to main content

​
Overview

This endpoint validates a fingerprint against the Department of Home Affairs database via the South African Fraud Prevention Service (SAFPS).

​
Endpoint

POST /Citizen/ValidateFingerPrint

​
Request

curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/ValidateFingerPrint" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ConsentReceived": true,
    "IdNumber": "8001014800080",
    "FingerPrint": "<base64_fingerprint_image>",
    "CRef": "REF00001"
  }'

​
Request Fields

FieldTypeRequiredDescription
ConsentReceivedbooleanYesMust be true
IdNumberstringYesSouth African 13-digit ID number
FingerPrintstringYesBase64-encoded fingerprint image
CRefstringNoYour transaction reference

​
Response

{
  "FingerPrintResult": {
    "isMatch": true,
    "confidence": 0.95
  },
  "Status": "Success",
  "CRef": "REF00001",
  "Message": "Fingerprint verified successfully"
}
FieldDescription
isMatchtrue if the fingerprint matches the DHA record
confidenceConfidence score of the fingerprint match (0–1)