Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Check whether a subject is registered in the didx:verify system.
POST /Citizen/GetRegistrationStatus
curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/GetRegistrationStatus" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"ConsentReceived": true,
"IdNumber": "8001014800080",
"CRef": "REF00001"
}'
| Field | Type | Required | Description |
|---|---|---|---|
ConsentReceived | boolean | Yes | Must be true |
IdNumber | string | Conditional | SA ID number to check |
MobileNumber | string | Conditional | Mobile number to check |
CRef | string | No | Your transaction reference |
IdNumber or MobileNumber. If you send both, the lookup uses IdNumber.
{
"IdNumber": "8001014800080",
"StatusCode": 2,
"StatusDescription": "Claimed",
"DHAImageAvailable": true,
"DHAFaceVerified": true,
"SelfieUrl": "",
"FirstName": "",
"LastName": "",
"CRef": "REF00001",
"Status": "Success",
"Message": "string"
}
| Field | Description |
|---|---|
IdNumber | ID number of the subject |
StatusCode | Registration status code. See Status codes |
StatusDescription | Registration status as text |
DHAImageAvailable | Whether a DHA image is available for the subject |
DHAFaceVerified | Whether the subject’s face was verified against DHA |
| Code | Status |
|---|---|
0 | NotFound |
1 | Unclaimed |
2 | Claimed |
3 | Suspicious |