Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Validate a fingerprint against the Department of Home Affairs via SAFPS.
POST /Citizen/ValidateFingerPrint
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",
"fP1No": 1,
"fP1WSQImage": "<base64_wsq_image>",
"CRef": "REF00001"
}'
| Field | Type | Required | Description |
|---|---|---|---|
ConsentReceived | boolean | Yes | Must be true |
IdNumber | string | Yes | South African 13-digit ID number |
fP1No | integer | Yes | Finger number of the first fingerprint |
fP1WSQImage | string | Yes | First fingerprint image in WSQ format |
fP2No | integer | No | Finger number of the second fingerprint |
fP2WSQImage | string | No | Second fingerprint image in WSQ format |
CacheEnabled | boolean | No | Allow offline (cached) response data |
CRef | string | No | Your transaction reference |
fP1No and fP2No.
{
"GoldenSource": {
"RetValue": {
"iErrField": 0,
"sErrorField": null,
"sTranIDField": "string",
"sIDNField": "8001014800080",
"sFPInd1Field": "string",
"sFPInd2Field": null,
"sFP1ResultField": "string",
"sFP2ResultField": null,
"iFP1ScoreField": 0,
"iFP2ScoreField": 0,
"yaPhotoField": null,
"sCallCentreNoField": null
},
"FingersResponse": null,
"IdNumber": "8001014800080",
"UserName": "string",
"OfficeName": "string",
"StationId": "string",
"Timestamp": "string",
"TransactionNumber": "string",
"CallCentreNoField": null
},
"OfflineCacheResult": null,
"RequestedBy": "string",
"AuthorizedBy": "string",
"CRef": "REF00001",
"Status": "Success",
"Message": "string"
}
| Field | Description |
|---|---|
GoldenSource | Result from the Department of Home Affairs |
GoldenSource.RetValue.iErrField | Error code. 0 means the request succeeded |
GoldenSource.RetValue.sErrorField | Error message, if any |
GoldenSource.RetValue.sFP1ResultField / sFP2ResultField | Match result for the first and second fingerprint |
GoldenSource.RetValue.iFP1ScoreField / iFP2ScoreField | Match score for the first and second fingerprint |
GoldenSource.TransactionNumber | Transaction number of the lookup |
OfflineCacheResult | Cached result, in the same shape as GoldenSource |